Struct RustdocSections 

pub struct RustdocSections {
    pub summary: String,
    pub arguments: Option<String>,
    pub returns: Option<String>,
    pub errors: Option<String>,
    pub panics: Option<String>,
    pub safety: Option<String>,
    pub example: Option<String>,
}

A parsed rustdoc comment broken out into the sections binding emitters care about.

summary is the leading prose paragraph(s) before any # Heading. Sections are stored verbatim (without the # Heading line itself); each binding is responsible for translating bullet lists and code fences into its host-native conventions.

Trailing/leading whitespace inside each field is trimmed so emitters can concatenate without producing * lines containing only spaces.

Fields

summary: String

Prose before the first # Section heading.

arguments: Option<String>

Body of the # Arguments section, if present.

returns: Option<String>

Body of the # Returns section, if present.

errors: Option<String>

Body of the # Errors section, if present.

panics: Option<String>

Body of the # Panics section, if present.

safety: Option<String>

Body of the # Safety section, if present.

example: Option<String>

Body of the # Example / # Examples section, if present.

Trait Implementations

impl Clone for RustdocSections

fn clone(&self) -> RustdocSections

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RustdocSections

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

Formats the value using the given formatter.

impl Default for RustdocSections

fn default() -> RustdocSections

Returns the “default value” for a type.

impl PartialEq for RustdocSections

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for RustdocSections

impl StructuralPartialEq for RustdocSections