Enum Tag

pub enum Tag<'a> {
    Paragraph,
    Heading {
        level: HeadingLevel,
        id: Option<CowStr<'a>>,
        classes: Vec<CowStr<'a>>,
        attrs: Vec<(CowStr<'a>, Option<CowStr<'a>>)>,
    },
    BlockQuote(Option<BlockQuoteKind>),
    CodeBlock(CodeBlockKind<'a>),
    HtmlBlock,
    List(Option<u64>),
    Item,
    FootnoteDefinition(CowStr<'a>),
    DefinitionList,
    DefinitionListTitle,
    DefinitionListDefinition,
    Table(Vec<Alignment>),
    TableHead,
    TableRow,
    TableCell,
    Emphasis,
    Strong,
    Strikethrough,
    Link {
        link_type: LinkType,
        dest_url: CowStr<'a>,
        title: CowStr<'a>,
        id: CowStr<'a>,
    },
    Image {
        link_type: LinkType,
        dest_url: CowStr<'a>,
        title: CowStr<'a>,
        id: CowStr<'a>,
    },
    MetadataBlock(MetadataBlockKind),
}

Tags for elements that can contain other elements.

Variants

Paragraph

A paragraph of text and other inline elements.

Heading

A heading, with optional identifier, classes and custom attributes. The identifier is prefixed with # and the last one in the attributes list is chosen, classes are prefixed with . and custom attributes have no prefix and can optionally have a value (myattr or myattr=myvalue).

Fields

level: HeadingLevel

id: Option<CowStr<'a>>

classes: Vec<CowStr<'a>>

attrs: Vec<(CowStr<'a>, Option<CowStr<'a>>)>

The first item of the tuple is the attr and second one the value.

BlockQuote(Option<BlockQuoteKind>)

CodeBlock(CodeBlockKind<'a>)

A code block.

HtmlBlock

A HTML block.

List(Option<u64>)

A list. If the list is ordered the field indicates the number of the first item. Contains only list items.

Item

A list item.

FootnoteDefinition(CowStr<'a>)

A footnote definition. The value contained is the footnote’s label by which it can be referred to.

DefinitionList

DefinitionListTitle

DefinitionListDefinition

Table(Vec<Alignment>)

A table. Contains a vector describing the text-alignment for each of its columns.

TableHead

A table header. Contains only TableCells. Note that the table body starts immediately after the closure of the TableHead tag. There is no TableBody tag.

TableRow

A table row. Is used both for header rows as body rows. Contains only TableCells.

TableCell

Emphasis

Strong

Strikethrough

Link

A link.

Fields

link_type: LinkType

dest_url: CowStr<'a>

title: CowStr<'a>

id: CowStr<'a>

Identifier of reference links, e.g. world in the link [hello][world].

Image

An image. The first field is the link type, the second the destination URL and the third is a title, the fourth is the link identifier.

Fields

link_type: LinkType

dest_url: CowStr<'a>

title: CowStr<'a>

id: CowStr<'a>

Identifier of reference links, e.g. world in the link [hello][world].

MetadataBlock(MetadataBlockKind)

A metadata block.

Implementations

impl<'a> Tag<'a>

pub fn to_end(&self) -> TagEnd

pub fn into_static(self) -> Tag<'static>

Trait Implementations

impl<'a> Clone for Tag<'a>

fn clone(&self) -> Tag<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Tag<'a>

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

Formats the value using the given formatter.

impl<'a> From<Tag<'a>> for TagEnd

fn from(value: Tag<'_>) -> Self

Converts to this type from the input type.

impl<'a> PartialEq for Tag<'a>

fn eq(&self, other: &Tag<'a>) -> 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<'a> StructuralPartialEq for Tag<'a>