pub(crate) struct DocFragment {
pub(crate) span: Span,
pub(crate) parent_module: Option<DefId>,
pub(crate) doc: Symbol,
pub(crate) kind: DocFragmentKind,
pub(crate) indent: usize,
}Expand description
A portion of documentation, extracted from a #[doc] attribute.
Each variant contains the line number within the complete doc-comment where the fragment starts, as well as the Span where the corresponding doc comment or attribute is located.
Included files are kept separate from inline doc comments so that proper line-number information can be given when a doctest fails. Sugared doc comments and “raw” doc comments are kept separate because of issue #42760.
Fields
span: Spanparent_module: Option<DefId>The module this doc-comment came from.
This allows distinguishing between the original documentation and a pub re-export.
If it is None, the item was not re-exported.
doc: Symbolkind: DocFragmentKindindent: usizeTrait Implementations
sourceimpl Clone for DocFragment
impl Clone for DocFragment
sourcefn clone(&self) -> DocFragment
fn clone(&self) -> DocFragment
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more
sourceimpl Debug for DocFragment
impl Debug for DocFragment
sourceimpl PartialEq<DocFragment> for DocFragment
impl PartialEq<DocFragment> for DocFragment
sourcefn eq(&self, other: &DocFragment) -> bool
fn eq(&self, other: &DocFragment) -> bool
This method tests for self and other values to be equal, and is used
by ==. Read more
sourcefn ne(&self, other: &DocFragment) -> bool
fn ne(&self, other: &DocFragment) -> bool
This method tests for !=.
impl Eq for DocFragment
impl StructuralEq for DocFragment
impl StructuralPartialEq for DocFragment
Auto Trait Implementations
impl RefUnwindSafe for DocFragment
impl !Send for DocFragment
impl !Sync for DocFragment
impl Unpin for DocFragment
impl UnwindSafe for DocFragment
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
impl<T> Pointable for T
impl<T> Pointable for T
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcepub fn to_owned(&self) -> T
pub fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
sourcepub fn clone_into(&self, target: &mut T)
pub fn clone_into(&self, target: &mut T)
toowned_clone_into)Uses borrowed data to replace owned data, usually by cloning. Read more
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
pub fn vzip(self) -> V
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber to this type, returning a
WithDispatch wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber to this type, returning a
WithDispatch wrapper. Read more
impl<'a, T> Captures<'a> for T where
T: ?Sized,
Layout
Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference’s “Type Layout” chapter for details on type layout guarantees.
Size: 32 bytes