Struct SectionBlock

pub struct SectionBlock<'src> { /* private fields */ }

Sections partition the document into a content hierarchy. A section is an implicit enclosure. Each section begins with a title and ends at the next sibling section, ancestor section, or end of document. Nested section levels must be sequential.

WARNING: This is a very preliminary implementation. There are many TO DO items in this code.

Implementations

impl<'src> SectionBlock<'src>

pub fn level(&self) -> usize

Return the section’s level.

The section title must be prefixed with a section marker, which indicates the section level. The number of equal signs in the marker represents the section level using a 0-based index (e.g., two equal signs represents level 1). A section marker can range from two to six equal signs and must be followed by a space.

This function will return an integer between 1 and 5.

pub fn section_title(&'src self) -> &'src Span<'src>

Return a Span containing the section title.

Trait Implementations

impl<'src> Clone for SectionBlock<'src>

fn clone(&self) -> SectionBlock<'src>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'src> Debug for SectionBlock<'src>

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

Formats the value using the given formatter.

impl<'src> HasSpan<'src> for SectionBlock<'src>

fn span(&'src self) -> &'src Span<'src>

Return a Span describing the syntactic element’s location within the source string/file.

impl<'src> IsBlock<'src> for SectionBlock<'src>

fn content_model(&self) -> ContentModel

Returns the ContentModel for this block.

fn raw_context(&self) -> CowStr<'src>

Returns the raw (uninterpreted) context for this block.

fn nested_blocks(&'src self) -> Iter<'src, Block<'src>>

Returns an iterator over the nested blocks contained within this block.

fn title(&'src self) -> Option<Span<'src>>

Returns the title for this block, if present.

fn anchor(&'src self) -> Option<Span<'src>>

Returns the anchor for this bloc, if present.

fn attrlist(&'src self) -> Option<&'src Attrlist<'src>>

Returns the attribute list for this block, if present.

fn resolved_context(&'src self) -> CowStr<'src>

Returns the resolved context for this block.

fn declared_style(&'src self) -> Option<Span<'src>>

Returns the declared (uninterpreted) style for this block.

fn id(&'src self) -> Option<Span<'src>>

Returns the ID for this block, if present.

fn roles(&'src self) -> Vec<Span<'src>>

Returns any role attributes that were found.

fn options(&'src self) -> Vec<Span<'src>>

Returns any option attributes that were found.

impl<'src> PartialEq for SectionBlock<'src>

fn eq(&self, other: &SectionBlock<'src>) -> bool

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

const 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<'src> Eq for SectionBlock<'src>

impl<'src> StructuralPartialEq for SectionBlock<'src>