Enum Block 

#[non_exhaustive]
pub enum Block {
    Heading(Text),
    Paragraph(Text),
    Verbatim(String),
    Fields(Fields),
    Table(Table),
    Section(Section),
    Notice(Notice),
    Rule(Rule),
}

Available on crate feature document only.

One block of a Document.

Each variant has a builder method on Document that wraps it. The enum is the read side: a custom renderer matches on it.

A new block, such as a panel, can join the set in a minor release. So a match on it outside ctl-core ends with a wildcard arm.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Heading(Text)

A heading, drawn in Role::Heading.

Paragraph(Text)

Prose that wraps to the width.

Verbatim(String)

Preformatted text whose line breaks survive rendering.

The renderer removes terminal control characters, bidirectional controls, and the Unicode line separators U+2028 and U+2029, but keeps newlines and tabs. It strips newlines from the end, and expands a tab to the next multiple of 8 cells. Other Unicode formatting characters stay.

Fields(Fields)

A record of label and value rows.

Table(Table)

A table, with or without a header row.

Section(Section)

A heading over a nested document.

Notice(Notice)

A level label with an optional code and a message.

Rule(Rule)

A horizontal rule, optionally titled.

Trait Implementations

impl Clone for Block

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Block

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

Formats the value using the given formatter.

impl Eq for Block

impl From<Fields> for Block

fn from(value: Fields) -> Self

Converts to this type from the input type.

impl From<Notice> for Block

fn from(value: Notice) -> Self

Converts to this type from the input type.

impl From<Rule> for Block

fn from(value: Rule) -> Self

Converts to this type from the input type.

impl From<Section> for Block

fn from(value: Section) -> Self

Converts to this type from the input type.

impl From<Table> for Block

fn from(value: Table) -> Self

Converts to this type from the input type.

impl PartialEq for Block

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Block