Struct Section 

#[non_exhaustive]
pub struct Section {
    pub metadata: BlockMetadata,
    pub title: Title,
    pub level: u8,
    pub content: Vec<Block>,
    pub location: Location,
}

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

title: Title

level: u8

content: Vec<Block>

location: Location

Implementations

impl Section

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

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

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

Set the metadata.

impl Section

pub fn generate_id(metadata: &BlockMetadata, title: &[InlineNode]) -> SafeId

Generate a section ID based on its title and metadata.

This function checks for explicit IDs in the following order:

1. metadata.id - from attribute list syntax like [id=foo]
2. metadata.anchors - from anchor syntax like [[foo]] or [#foo]

If no explicit ID is found, it generates one from the title by converting to lowercase, replacing spaces and hyphens with underscores, and removing non-alphanumeric characters.

Trait Implementations

impl Clone for Section

fn clone(&self) -> Section

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Section

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

Formats the value using the given formatter.

impl PartialEq for Section

fn eq(&self, other: &Section) -> 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 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 StructuralPartialEq for Section