Struct MetadataElem 

pub struct MetadataElem {
    pub value: Value,
}

Exposes a value to the query system without producing visible content.

This element can be retrieved with the [query] function and from the command line with typst query. Its purpose is to expose an arbitrary value to the introspection system. To identify a metadata value among others, you can attach a [label] to it and query for that label.

The metadata element is especially useful for command line queries because it allows you to expose arbitrary values to the outside world.

// Put metadata somewhere.
#metadata("This is a note") <note>

// And find it from anywhere else.
#context {
  query(<note>).first().value
}

Fields

value: Value

Implementations

impl MetadataElem

pub fn new(value: Value) -> Self

Create a new instance of the element.

impl MetadataElem

pub const value: Field<Self, 0u8>

Trait Implementations

impl Clone for MetadataElem

fn clone(&self) -> MetadataElem

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Construct for MetadataElem

fn construct(engine: &mut Engine<'_>, args: &mut Args) -> SourceResult<Content>

Construct an element from the arguments.

impl Debug for MetadataElem

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

Formats the value using the given formatter.

impl Hash for MetadataElem

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl NativeElement for MetadataElem

const ELEM: Element

The associated element.

fn pack(self) -> Content

Pack the element into type-erased content.

impl RequiredField<0> for MetadataElem

const FIELD: RequiredFieldData<Self, 0u8>

type Type = Value

impl Set for MetadataElem

fn set(engine: &mut Engine<'_>, args: &mut Args) -> SourceResult<Styles>

Parse relevant arguments into style properties for this element.