Skip to main content

SectionNode

Struct SectionNode 

Source
pub struct SectionNode {
    pub name: String,
    pub depth: u8,
    pub pos: SourcePos,
    pub sections: Vec<SectionNode>,
    pub blocks: Vec<BlockNode>,
    pub anchors: Vec<String>,
    pub range: Range<usize>,
}
Expand description

A heading-delimited section: exact heading text, TRUE heading depth (a skipped level is preserved, not synthesized), heading position, nested subsections, heading-direct blocks (no hoisting), and section-level anchors.

Fields§

§name: String

heading text, trimmed (exact, case-sensitive)

§depth: u8

1..6 (the synthetic root is depth 1)

§pos: SourcePos

the heading’s position

§sections: Vec<SectionNode>

nested subsections

§blocks: Vec<BlockNode>

blocks directly under the heading

§anchors: Vec<String>

section-level ^block-ids (block-bound ids live on the block)

§range: Range<usize>

the section’s bytes in DocTree::body: from the start of its heading line to the start of the next heading of the same or a shallower depth, or the end of the body. Subsections are inside it. The root’s range is the whole body.

Implementations§

Source§

impl SectionNode

Source

pub fn block_by_id(&self, id: &str) -> Option<&BlockNode>

The first block bound to ^id, here or in any subsection, depth first.

Trait Implementations§

Source§

impl Clone for SectionNode

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SectionNode

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for SectionNode

Source§

impl PartialEq for SectionNode

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for SectionNode

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.