Skip to main content

BlockClass

Enum BlockClass 

Source
pub enum BlockClass {
    Paragraph,
    Heading,
    List,
    ListItem,
    Quote,
    Code,
    Table,
    Media,
    Directive,
    Rule,
    Footnote,
    Other,
}
Expand description

The block kinds core tells apart when it walks a document — the vocabulary Boundary is spelled in. A statement about structure, not about how any of it should look: what a frontend does with “this gap sits above a heading” is entirely the frontend’s.

Class rather than Kind because twig::BlockKind already means something else in this crate’s public surface — the command vocabulary (Paragraph | Heading(n)) a toolbar passes to Doc::set_block. This is the reverse direction: what a block already is, read back off a rendered row.

BlockClass::Other is the honest answer for a node kind core doesn’t separate out, so adding one here is additive for every frontend: nothing has to change until it wants to space that kind differently.

Variants§

§

Paragraph

§

Heading

§

List

A whole list. Its items are BlockClass::ListItem; note that core draws no boundary row between two items of one list, tight or loose, so an item↔item pair never reaches a frontend.

§

ListItem

§

Quote

§

Code

§

Table

§

Media

A block-level image, video, or audio.

§

Directive

A :::name{.class} directive container.

§

Rule

§

Footnote

§

Other

Implementations§

Source§

impl BlockClass

Source

pub fn from_node_kind(kind: &Kind) -> BlockClass

Classify a twig node kind — the same vocabulary [Builder::block] matches on, so the two can’t drift about what a block is. Both the whole-arena walk (which has FlatNodes) and the incremental top-level walk (which has only a query match’s kind) reach it by this one door.

Trait Implementations§

Source§

impl Clone for BlockClass

Source§

fn clone(&self) -> BlockClass

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 Copy for BlockClass

Source§

impl Debug for BlockClass

Source§

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

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

impl Eq for BlockClass

Source§

impl PartialEq for BlockClass

Source§

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

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<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 = Infallible

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.