Enum Block

#[non_exhaustive]
pub enum Block<'src> {
    Simple(SimpleBlock<'src>),
    Macro(MacroBlock<'src>),
    Section(SectionBlock<'src>),
    RawDelimited(RawDelimitedBlock<'src>),
}

Block elements form the main structure of an AsciiDoc document, starting with the document itself.

A block element (aka block) is a discrete, line-oriented chunk of content in an AsciiDoc document. Once parsed, that chunk of content becomes a block element in the parsed document model. Certain blocks may contain other blocks, so we say that blocks can be nested. The converter visits each block in turn, in document order, converting it to a corresponding chunk of output.

This enum represents all of the block types that are understood directly by this parser and also implements the IsBlock trait.

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.

Simple(SimpleBlock<'src>)

A block that’s treated as contiguous lines of paragraph text (and subject to normal substitutions) (e.g., a paragraph block).

Macro(MacroBlock<'src>)

A block macro is a syntax for representing non-text elements or syntax that expands into text using the provided metadata.

Section(SectionBlock<'src>)

A section helps to partition the document into a content hierarchy. May also be a part, chapter, or special section.

RawDelimited(RawDelimitedBlock<'src>)

A delimited block that contains verbatim, raw, or comment text. The content between the matching delimiters is not parsed for block syntax.

Trait Implementations

impl<'src> Clone for Block<'src>

fn clone(&self) -> Block<'src>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'src> Debug for Block<'src>

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

Formats the value using the given formatter.

impl<'src> HasSpan<'src> for Block<'src>

fn span(&'src self) -> &'src Span<'src>

Return a Span describing the syntactic element’s location within the source string/file.

impl<'src> IsBlock<'src> for Block<'src>

fn content_model(&self) -> ContentModel

Returns the ContentModel for this block.

fn context(&self) -> CowStr<'src>

Returns the context for this block.

fn nested_blocks(&'src self) -> Iter<'src, Block<'src>>

Returns an iterator over the nested blocks contained within this block.

impl<'src> PartialEq for Block<'src>

fn eq(&self, other: &Block<'src>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'src> Eq for Block<'src>

impl<'src> StructuralPartialEq for Block<'src>