Struct Section 

pub struct Section { /* private fields */ }

One heading and everything beneath it.

A section carries a handle to its document’s source, so body() and content() work wherever the section travels.

Implementations

impl Section

pub fn level(&self) -> HeadingLevel

The heading depth.

pub fn heading(&self) -> &str

The heading text, without # markers.

pub fn slug(&self) -> &Slug

The document-unique slug.

pub fn children(&self) -> &[Section]

Immediate subsections.

pub fn is_leaf(&self) -> bool

Whether this section has no subsections.

pub fn span(&self) -> Range<usize>

Byte range of the whole section within the document source.

pub fn body(&self) -> &str

Prose directly under this heading, excluding subsections.

pub fn content(&self) -> &str

Heading, prose, and every subsection — the slice to hand a model when it needs one part of a long skill.

pub fn walk(&self) -> impl Iterator<Item = (usize, &Section)>

This section and its descendants, depth-first, with depth relative to this section (0 for itself).

pub fn links(&self) -> Vec<Link>

Inline links appearing anywhere within this section.

Trait Implementations

impl Clone for Section

fn clone(&self) -> Self

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 Eq for Section

impl PartialEq for Section

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

Equality operator ==.

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

Inequality operator !=.