Skip to main content

BlockNode

Enum BlockNode 

Source
pub enum BlockNode {
    Table {
        columns: Vec<String>,
        rows: Vec<Vec<String>>,
        row_pos: Vec<SourcePos>,
        anchor: Option<String>,
        pos: SourcePos,
        range: Range<usize>,
    },
    List {
        ordered: bool,
        items: Vec<ListItem>,
        anchor: Option<String>,
        pos: SourcePos,
        range: Range<usize>,
    },
    Code {
        lang: Option<String>,
        value: String,
        fenced: bool,
        anchor: Option<String>,
        pos: SourcePos,
        range: Range<usize>,
    },
    Paragraph {
        text: String,
        anchor: Option<String>,
        pos: SourcePos,
        range: Range<usize>,
    },
}
Expand description

A flattened content block directly under a section heading.

Variants§

§

Table

A table.

Fields

§columns: Vec<String>

the header cells

§rows: Vec<Vec<String>>

the body rows, as cell text

§row_pos: Vec<SourcePos>

body-row index → source position (the TS rowPos(i) closure, as data)

§anchor: Option<String>

the ^block-id bound to the table, if any

§pos: SourcePos

where the table starts

§range: Range<usize>

the bytes of the table in DocTree::body

§

List

A list.

Fields

§ordered: bool

whether the list is ordered

§items: Vec<ListItem>

the items

§anchor: Option<String>

the ^block-id bound to the list, if any

§pos: SourcePos

where the list starts

§range: Range<usize>

the bytes of the list in DocTree::body

§

Code

A fenced or indented code block.

Fields

§lang: Option<String>

the info-string language, if any

§value: String

the code, without the fences

§fenced: bool

true for a fenced block, whose value starts on the line after pos; an indented block’s value starts on pos.line

§anchor: Option<String>

the ^block-id bound to the block, if any

§pos: SourcePos

where the block starts

§range: Range<usize>

the bytes of the block in DocTree::body

§

Paragraph

A paragraph.

Fields

§text: String

the paragraph text

§anchor: Option<String>

the ^block-id bound to the paragraph, if any

§pos: SourcePos

where the paragraph starts

§range: Range<usize>

the bytes of the paragraph in DocTree::body

Implementations§

Source§

impl BlockNode

Source

pub fn kind(&self) -> BlockKind

The kind of block.

Source

pub fn pos(&self) -> SourcePos

Where the block starts.

Source

pub fn range(&self) -> Range<usize> ⓘ

The block’s bytes in DocTree::body, from its first byte to its last (an absorbed ^block-id line included).

Source

pub fn anchor(&self) -> Option<&str>

The ^block-id bound to the block, if any.

Trait Implementations§

Source§

impl Clone for BlockNode

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 BlockNode

Source§

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

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

impl Eq for BlockNode

Source§

impl PartialEq for BlockNode

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 BlockNode

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.