Struct rustdoc::clean::types::DocFragment
source · 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: Span
parent_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: Symbol
kind: DocFragmentKind
indent: usize
Trait Implementations
sourceimpl Clone for DocFragment
impl Clone for DocFragment
sourcefn clone(&self) -> DocFragment
fn clone(&self) -> DocFragment
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresourceimpl 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
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 Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
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<V, T> VZip<V> for Twhere
V: MultiLane<T>,
impl<V, T> VZip<V> for Twhere
V: MultiLane<T>,
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>,
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
impl<'a, T> Captures<'a> for Twhere
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