Struct rustdoc::clean::types::DocFragment

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,
}

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

impl Clone for DocFragment

fn clone(&self) -> DocFragment

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DocFragment

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<DocFragment> for DocFragment

fn eq(&self, other: &DocFragment) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for DocFragment

impl StructuralEq for DocFragment

impl StructuralPartialEq for DocFragment

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