Struct Section 

#[non_exhaustive]
pub struct Section<'a> {
    pub metadata: BlockMetadata<'a>,
    pub title: Title<'a>,
    pub level: u8,
    pub content: Vec<Block<'a>>,
    pub kind: SectionKind,
    pub location: Location,
    /* private fields */
}

A Section represents a section in a document.

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.

metadata: BlockMetadata<'a>

title: Title<'a>

level: u8

content: Vec<Block<'a>>

kind: SectionKind

The section’s structural category (special-section style, or Normal).

location: Location

Implementations

impl<'a> Section<'a>

pub fn new( title: Title<'a>, level: u8, content: Vec<Block<'a>>, location: Location, ) -> Self

Create a new section with the given title, level, content, and location.

pub fn with_metadata(self, metadata: BlockMetadata<'a>) -> Self

Set the metadata.

pub fn id(&self) -> Cow<'a, str>

Return the explicit or parser-assigned section ID.

Parsed sections avoid collisions with preceding targets when generating IDs. Caller-created sections use the title-derived ID without collision checks.

pub fn with_numbering(self, enabled: bool) -> Self

Include or exclude this section from automatic numbering.

Section::new disables numbering. Call Document::renumber_sections after changing this policy on a section in a document.

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.

impl<'a> Section<'a>

pub fn generate_id_string( metadata: &BlockMetadata<'a>, title: &[InlineNode<'a>], ) -> String

Generate a section ID based on its title and metadata, returning a String directly.

Returns the Display-formatted form (prefixed with _ for generated IDs) without checking for collisions. Use Section::id for parsed sections.

Trait Implementations

impl<'a> Clone for Section<'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 Section<'a>

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

Formats the value using the given formatter.

impl<'a> PartialEq for Section<'a>

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Section<'_>

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 Section<'a>