Enum Tag

pub enum Tag<'a> {
    Paragraph,
    Show(ShowType, CowStr<'a>, Option<(CowStr<'a>, CowStr<'a>, CowStr<'a>)>, Option<CowStr<'a>>),
    Heading(NonZero<u8>, TableOfContents, Bookmarks),
    CodeBlock(Option<CowStr<'a>>, CodeBlockDisplay),
    BulletList(Option<&'a str>, bool),
    NumberedList(u64, Option<NumberingPattern<'a>>, bool),
    Item,
    Quote(QuoteType, QuoteQuotes, Option<CowStr<'a>>),
    Emphasis,
    Strong,
    Strikethrough,
    Link(LinkType, CowStr<'a>),
    Table(Vec<TableCellAlignment>),
    TableHead,
    TableRow,
    TableCell,
}

Tags for elements that can contain other elements.

Variants

Paragraph

A paragraph of text and other inline elements.

Show(ShowType, CowStr<'a>, Option<(CowStr<'a>, CowStr<'a>, CowStr<'a>)>, Option<CowStr<'a>>)

A show rule.

See https://typst.app/docs/reference/styling/#show-rules.

Heading(NonZero<u8>, TableOfContents, Bookmarks)

A heading. The first field indicates the level of the heading, the second if it should be included in outline, and the third if it should be included in bookmarks.

CodeBlock(Option<CowStr<'a>>, CodeBlockDisplay)

A code block. The first argument is the fenced value if it exists, the second is how it should be displayed.

BulletList(Option<&'a str>, bool)

A bullted list. The first field indicates the marker to use, the second is if tight is desired. Contains only list items.

NumberedList(u64, Option<NumberingPattern<'a>>, bool)

A numbered / enumerated list (also called an enum by typst). The first field indicates the starting number, the second is the numbering pattern, the third is if tight is desired. Contains only list items.

See https://typst.app/docs/reference/layout/enum/.

Item

A list item.

Quote(QuoteType, QuoteQuotes, Option<CowStr<'a>>)

A quote. The second argument determines if it should be wrapped in quotes. The third argument is the attribution value if it exists.

See https://typst.app/docs/reference/model/quote/.

Emphasis

Strong

Strikethrough

Link(LinkType, CowStr<'a>)

A link. The first field is the type and the second is the destination URL.

Table(Vec<TableCellAlignment>)

A table. The first field is the alignment of each column.

TableHead

A table header row. Must come after a #Tag::Table.

TableRow

A table row. Must come after a #Tag::Table.

TableCell

A table row. Must come after a #Tag::TableRow.

Trait Implementations

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

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

Returns a duplicate 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<(), Error>

Formats the value using the given formatter.

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>