Skip to main content

Block

Enum Block 

Source
pub enum Block {
    Heading {
        level: u8,
        lemma: String,
    },
    Paragraph {
        text: String,
    },
    Text {
        text: String,
    },
    Open {
        kind: Container,
        lemma: Option<String>,
    },
    Close {
        hypograph: Option<String>,
    },
    Verbatim {
        lang: Option<String>,
        text: String,
    },
    NoteRef {
        onym: String,
        family: Option<NoteFamily>,
        margin: bool,
    },
    IndexMark {
        term: String,
    },
    Verse {
        lemma: Option<String>,
        strophes: Vec<Vec<String>>,
        hypograph: Option<String>,
    },
    Table {
        lemma: Option<String>,
        headers: Option<Vec<String>>,
        rows: Vec<Vec<Cell>>,
    },
}
Expand description

A block-level event in the text-level vocabulary — what a format adapter emits. Headings arrive flat; the section tree is derived here, once, for every adapter.

Variants§

§

Heading

A flat heading: level is the source level (h2 → 2, a LaTeX \section → its depth), lemma its text.

Fields

§level: u8
§lemma: String
§

Paragraph

A plain paragraph — the implicit, lemma-less block.

Fields

§text: String
§

Text

Inline content belonging directly to the open container (a list item’s own text, a bare-text blockquote). With no open container it is read as a paragraph.

Fields

§text: String
§

Open

Open a nesting container. Items take their unordered- / ordered- flavor (and taxis) from the enclosing list.

Fields

§

Close

Close the innermost open container, optionally with its hypograph (footer or attribution).

Fields

§hypograph: Option<String>
§

Verbatim

A verbatim block — code or other preformatted lines, kept as authored.

Fields

§text: String
§

NoteRef

An in-text note callout (the deixis, ruling #35): onym names the body it cites within its family. Emitted after the flow block it sits in; it becomes that block’s child, in order, and the block’s own text stays clean of markers. family: None means the source declares none (an HTML noteref): the callout takes its resolved body’s family, and a dangling one defaults to footnote.

Fields

§onym: String
§margin: bool

The declared spelling placed this pair in the margin (a Tufte-style sidenote): surfaced as ::::form = "margin" on both ends — the family stays footnote, placement is presentation.

§

IndexMark

An index mark (ruling #36): an invisible anchor declaring this place concerns term. The back-of-book index is a query over these, never a stored structure.

Fields

§term: String
§

Verse

A verse block (ruling #37 — litogramma’s stichoi model): strophes of lines, denormalized like Block::Table. Lines arrive flattened by the adapter and are kept as authored; the stichos ::taxis numbers lines 1-based, CONTINUOUSLY across strophes — the citation coordinate.

Fields

§strophes: Vec<Vec<String>>
§hypograph: Option<String>
§

Table

A table, denormalized here into nested lists (rows = ordered items with the <row> trait, cells = unordered items with the <cell> trait and the column name as ::lemma). Header detection is the adapter’s job; the lowering rule lives here. A cell’s own label (a row’s th) wins over the positional headers entry.

Fields

§headers: Option<Vec<String>>
§rows: Vec<Vec<Cell>>

Trait Implementations§

Source§

impl Clone for Block

Source§

fn clone(&self) -> Block

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 Block

Source§

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

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

impl PartialEq for Block

Source§

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

Auto Trait Implementations§

§

impl Freeze for Block

§

impl RefUnwindSafe for Block

§

impl Send for Block

§

impl Sync for Block

§

impl Unpin for Block

§

impl UnsafeUnpin for Block

§

impl UnwindSafe for Block

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<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, <T as TryFrom<U>>::Error>

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.