Enum jotdown::Container

pub enum Container<'s> {
    Blockquote,
    List {
        kind: ListKind,
        tight: bool,
    },
    ListItem,
    TaskListItem {
        checked: bool,
    },
    DescriptionList,
    DescriptionDetails,
    Footnote {
        tag: &'s str,
        number: usize,
    },
    Table,
    TableRow {
        head: bool,
    },
    Section {
        id: Cow<'s, str>,
    },
    Div {
        class: Option<&'s str>,
    },
    Paragraph,
    Heading {
        level: u16,
        has_section: bool,
        id: Cow<'s, str>,
    },
    TableCell {
        alignment: Alignment,
        head: bool,
    },
    Caption,
    DescriptionTerm,
    RawBlock {
        format: &'s str,
    },
    CodeBlock {
        lang: Option<&'s str>,
    },
    Span,
    Link(Cow<'s, str>, LinkType),
    Image(Cow<'s, str>, SpanLinkType),
    Verbatim,
    Math {
        display: bool,
    },
    RawInline {
        format: &'s str,
    },
    Subscript,
    Superscript,
    Insert,
    Delete,
    Strong,
    Emphasis,
    Mark,
}

A container that may contain other elements.

There are three types of containers:

• inline, may only contain inline elements,
• block leaf, may only contain inline elements,
• block container, may contain any block-level elements.

Variants

Blockquote

A blockquote element.

List

Fields

kind: ListKind

tight: bool

A list.

ListItem

An item of a list

TaskListItem

Fields

checked: bool

An item of a task list, either checked or unchecked.

DescriptionList

A description list element.

DescriptionDetails

Details describing a term within a description list.

Footnote

Fields

tag: &'s str

number: usize

A footnote definition.

Table

A table element.

TableRow

Fields

head: bool

A row element of a table.

Section

Fields

id: Cow<'s, str>

A section belonging to a top level heading.

Div

Fields

class: Option<&'s str>

A block-level divider element.

Paragraph

A paragraph.

Heading

Fields

level: u16

has_section: bool

id: Cow<'s, str>

A heading.

TableCell

Fields

alignment: Alignment

head: bool

A cell element of row within a table.

Caption

A caption within a table.

DescriptionTerm

A term within a description list.

RawBlock

Fields

format: &'s str

A block with raw markup for a specific output format.

CodeBlock

Fields

lang: Option<&'s str>

A block with code in a specific language.

Span

An inline divider element.

Link(Cow<'s, str>, LinkType)

An inline link with a destination URL.

Image(Cow<'s, str>, SpanLinkType)

An inline image with a source URL. Inner Str objects compose the alternative text.

Verbatim

An inline verbatim string.

Math

Fields

display: bool

An inline or display math element.

RawInline

Fields

format: &'s str

Inline raw markup for a specific output format.

Subscript

A subscripted element.

Superscript

A superscripted element.

Insert

An inserted inline element.

Delete

A deleted inline element.

Strong

An inline element emphasized with a bold typeface.

Emphasis

An emphasized inline element.

Mark

A highlighted inline element.

Trait Implementations

impl<'s> Debug for Container<'s>

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

Formats the value using the given formatter.

impl<'s> PartialEq<Container<'s>> for Container<'s>

fn eq(&self, other: &Container<'s>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<'s> Eq for Container<'s>

impl<'s> StructuralEq for Container<'s>

impl<'s> StructuralPartialEq for Container<'s>