Struct TocEntry 

#[non_exhaustive]
pub struct TocEntry<'a> {
    pub id: &'a str,
    pub title: Title<'a>,
    pub level: u8,
    pub xreflabel: Option<&'a str>,
    pub kind: SectionKind,
    pub location: Location,
    /* private fields */
}

A TocEntry represents a table of contents entry.

This is collected during parsing from Section.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

id: &'a str

Unique identifier for this section (used for anchor links)

title: Title<'a>

Title of the section

level: u8

Section level (1 for top-level, 2 for subsection, etc.)

xreflabel: Option<&'a str>

Optional cross-reference label from reftext= or [[id,xreflabel]].

kind: SectionKind

The section’s structural category (special-section style, or Normal). Converters use it for presentation, such as appendix labels.

location: Location

Location of the section heading (the cross-reference target).

Implementations

impl<'a> TocEntry<'a>

pub fn number(&self) -> Option<&str>

Return the assigned number without presentation punctuation or a signifier.

Examples are 1, 1.2, IV, and A.1.

Trait Implementations

impl<'a> Clone for TocEntry<'a>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for TocEntry<'a>

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

Formats the value using the given formatter.

impl<'a> PartialEq for TocEntry<'a>

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for TocEntry<'_>

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a> StructuralPartialEq for TocEntry<'a>