Skip to main content

Block

Enum Block 

Source
pub enum Block {
    Heading {
        id: NodeId,
        level: HeadingLevel,
        inlines: Vec<Inline>,
        attributes: Attributes,
        position: Option<SourcePos>,
        span: Option<SourceSpan>,
    },
    Paragraph {
        id: NodeId,
        inlines: Vec<Inline>,
        attributes: Attributes,
        position: Option<SourcePos>,
        span: Option<SourceSpan>,
    },
    Blockquote {
        id: NodeId,
        blocks: Vec<Block>,
        attributes: Attributes,
        position: Option<SourcePos>,
        span: Option<SourceSpan>,
    },
    CodeBlock {
        id: NodeId,
        info: Option<String>,
        text: String,
        attributes: Attributes,
        position: Option<SourcePos>,
        span: Option<SourceSpan>,
    },
    ThematicBreak {
        id: NodeId,
        attributes: Attributes,
        position: Option<SourcePos>,
        span: Option<SourceSpan>,
    },
    PageBreak {
        id: NodeId,
        attributes: Attributes,
        position: Option<SourcePos>,
        span: Option<SourceSpan>,
    },
    ColumnBreak {
        id: NodeId,
        attributes: Attributes,
        position: Option<SourcePos>,
        span: Option<SourceSpan>,
    },
    Image {
        id: NodeId,
        url: String,
        alt: String,
        attributes: Attributes,
        position: Option<SourcePos>,
        span: Option<SourceSpan>,
    },
    List {
        id: NodeId,
        ordered: bool,
        start: u32,
        tight: bool,
        items: Vec<ListItem>,
        attributes: Attributes,
        position: Option<SourcePos>,
        span: Option<SourceSpan>,
    },
    Table {
        id: NodeId,
        head: Vec<Row>,
        body: Vec<Row>,
        attributes: Attributes,
        position: Option<SourcePos>,
        span: Option<SourceSpan>,
    },
}
Expand description

A block-level element: the unit of fragmentation input.

Variants§

§

Heading

# through ######; levels outside 1–6 are rejected at parse.

Fields

§id: NodeId

Engine-assigned identity, for diagnostics; never serialized.

§level: HeadingLevel

# count, 1-6.

§inlines: Vec<Inline>

The heading’s text, in reading order.

§attributes: Attributes

What a sheet names it by.

§position: Option<SourcePos>

Where the frontend read this from.

§span: Option<SourceSpan>

The bytes of that source it was read from.

§

Paragraph

A run of prose: the unit line layout breaks.

Fields

§id: NodeId

Engine-assigned identity, for diagnostics; never serialized.

§inlines: Vec<Inline>

The paragraph’s text, in reading order.

§attributes: Attributes

What a sheet names it by.

§position: Option<SourcePos>

Where the frontend read this from.

§span: Option<SourceSpan>

The bytes of that source it was read from.

§

Blockquote

A quotation set off by >; contents are blocks, not inlines — blockquotes nest.

Fields

§id: NodeId

Engine-assigned identity, for diagnostics; never serialized.

§blocks: Vec<Block>

The quoted blocks, in reading order.

§attributes: Attributes

What a sheet names it by.

§position: Option<SourcePos>

Where the frontend read this from.

§span: Option<SourceSpan>

The bytes of that source it was read from.

§

CodeBlock

A code block: preformatted text, set as it was written.

It holds text rather than inlines, because a code block has no markup inside it. The text keeps the newlines and the spaces the author wrote, and those are what its lines break at.

Fields

§id: NodeId

Engine-assigned identity, for diagnostics; never serialized.

§info: Option<String>

The word after the opening fence, where one was written. It is carried for a painter that reads it, and the engine makes nothing of it.

§text: String

The block’s text, newlines and indentation intact.

§attributes: Attributes

What a sheet names it by.

§position: Option<SourcePos>

Where the frontend read this from.

§span: Option<SourceSpan>

The bytes of that source it was read from.

§

ThematicBreak

---: a scene break, rendered as space or an ornament (❦).

Fields

§id: NodeId

Engine-assigned identity, for diagnostics; never serialized.

§attributes: Attributes

What a sheet names it by.

§position: Option<SourcePos>

Where the frontend read this from.

§span: Option<SourceSpan>

The bytes of that source it was read from.

§

PageBreak

\pagebreak: what follows it starts a new page. It holds no text and takes no height.

Fields

§id: NodeId

Engine-assigned identity, for diagnostics; never serialized.

§attributes: Attributes

What a sheet names it by.

§position: Option<SourcePos>

Where the frontend read this from.

§span: Option<SourceSpan>

The bytes of that source it was read from.

§

ColumnBreak

\columnbreak: what follows it starts the next column. It holds no text and takes no height.

Fields

§id: NodeId

Engine-assigned identity, for diagnostics; never serialized.

§attributes: Attributes

What a sheet names it by.

§position: Option<SourcePos>

Where the frontend read this from.

§span: Option<SourceSpan>

The bytes of that source it was read from.

§

Image

A block-level image.

Fields

§id: NodeId

Engine-assigned identity, for diagnostics; never serialized.

§url: String

Where the image lives; the host resolves it, not the engine.

§alt: String

Alt text: not laid out, but part of the accessibility contract.

§attributes: Attributes

What a sheet names it by.

§position: Option<SourcePos>

Where the frontend read this from.

§span: Option<SourceSpan>

The bytes of that source it was read from.

§

List

A list of items, numbered or not. An item holds blocks, as a blockquote does, so a list nests inside an item of another.

Fields

§id: NodeId

Engine-assigned identity, for diagnostics; never serialized.

§ordered: bool

Whether the items are numbered.

§start: u32

The number of the first item of a numbered list.

§tight: bool

Whether the source wrote the items without blank lines between them: a list of phrases rather than a list of paragraphs.

§items: Vec<ListItem>

The items, in reading order.

§attributes: Attributes

What a sheet names it by.

§position: Option<SourcePos>

Where the frontend read this from.

§span: Option<SourceSpan>

The bytes of that source it was read from.

§

Table

A grid of cells. A cell holds blocks, as a blockquote does.

Fields

§id: NodeId

Engine-assigned identity, for diagnostics; never serialized.

§head: Vec<Row>

The header rows, which name the columns, in reading order.

§body: Vec<Row>

The body rows, in reading order.

§attributes: Attributes

What a sheet names it by.

§position: Option<SourcePos>

Where the frontend read this from.

§span: Option<SourceSpan>

The bytes of that source it was read from.

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<'de> Deserialize<'de> for Block

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. 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 Serialize for Block

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. 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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

§

impl<T> ErasedDestructor for T
where T: 'static,

§

impl<T> Finish for T

§

fn finish(self)

Does nothing but move self, equivalent to drop.
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
§

impl<U, T> ToOwnedObj<U> for T
where U: FromObjRef<T>,

§

fn to_owned_obj(&self, data: FontData<'_>) -> U

Convert this type into T, using the provided data to resolve any offsets.
§

impl<U, T> ToOwnedTable<U> for T
where U: FromTableRef<T>,

§

fn to_owned_table(&self) -> U

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.