Enum pulldown_typst::Event

pub enum Event<'a> {
    Start(Tag<'a>),
    End(Tag<'a>),
    Text(CowStr<'a>),
    Code(CowStr<'a>),
    Linebreak,
    Parbreak,
    PageBreak,
    Line,
    Let(CowStr<'a>, CowStr<'a>),
    FunctionCall(Option<CowStr<'a>>, CowStr<'a>, Vec<CowStr<'a>>),
    DocumentFunctionCall(Vec<CowStr<'a>>),
    Set(CowStr<'a>, CowStr<'a>, CowStr<'a>),
    DocumentSet(CowStr<'a>, CowStr<'a>),
    Raw(CowStr<'a>),
}

Variants

Start(Tag<'a>)

Start of a tagged element. Events that are yielded after this event and before its corresponding End event are inside this element. Start and end events are guaranteed to be balanced.

End(Tag<'a>)

End of a tagged element.

Text(CowStr<'a>)

A text node.

Code(CowStr<'a>)

An inline code node.

Linebreak

A soft line break.

Parbreak

A hard line break.

PageBreak

A page break.

Line

A line.

Let(CowStr<'a>, CowStr<'a>)

A let binding. First argument is lhs, second is rhs.

See https://typst.app/docs/reference/scripting/#bindings.

FunctionCall(Option<CowStr<'a>>, CowStr<'a>, Vec<CowStr<'a>>)

A function call. The first field is the target variable (without #), the second is the function name, and the third is a list of arguments.

If calling document(), prefer [DocumentFunctionCall].

DocumentFunctionCall(Vec<CowStr<'a>>)

A document function call. The field is the list of arguments.

Prefer this over the more general FunctionCall as document calls must appear before any content.

See https://typst.app/docs/reference/meta/document.

Set(CowStr<'a>, CowStr<'a>, CowStr<'a>)

A set rule.

If setting document metadata, prefer [DocumentSet].

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

DocumentSet(CowStr<'a>, CowStr<'a>)

A document set rule. The first field is the parameter name, the second is the parameter value.

Prefer this over the more general [Set] as document set rules must appear before any content.

See https://typst.app/docs/reference/meta/document.

Raw(CowStr<'a>)

Raw string data what will be bassed through directly to typst. Prefer using other strongly-typed rules.

Trait Implementations

impl<'a> Clone for Event<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Event<'a>

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

Formats the value using the given formatter.

impl<'a> PartialEq for Event<'a>

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