Struct NativeFuncData

pub struct NativeFuncData {
    pub function: fn(_: &mut Engine<'_>, _: Tracked<'_, Context<'_>>, _: &mut Args) -> Result<Value, EcoVec<SourceDiagnostic>>,
    pub name: &'static str,
    pub title: &'static str,
    pub docs: &'static str,
    pub keywords: &'static [&'static str],
    pub contextual: bool,
    pub scope: LazyLock<Scope>,
    pub params: LazyLock<Vec<ParamInfo>>,
    pub returns: LazyLock<CastInfo>,
}

Defines a native function.

Fields

function: fn(_: &mut Engine<'_>, _: Tracked<'_, Context<'_>>, _: &mut Args) -> Result<Value, EcoVec<SourceDiagnostic>>

Invokes the function from Typst.

name: &'static str

The function’s normal name (e.g. align), as exposed to Typst.

title: &'static str

The function’s title case name (e.g. Align).

docs: &'static str

The documentation for this function as a string.

keywords: &'static [&'static str]

A list of alternate search terms for this function.

contextual: bool

Whether this function makes use of context.

scope: LazyLock<Scope>

Definitions in the scope of the function.

params: LazyLock<Vec<ParamInfo>>

A list of parameter information for each parameter.

returns: LazyLock<CastInfo>

Information about the return value of this function.

Trait Implementations

impl Debug for NativeFuncData

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

Formats the value using the given formatter.

impl From<&'static NativeFuncData> for Func

fn from(data: &'static NativeFuncData) -> Func

Converts to this type from the input type.

impl IntoValue for &'static NativeFuncData

fn into_value(self) -> Value

Cast this type into a value.

impl PartialEq<&'static NativeFuncData> for Func

fn eq(&self, other: &&'static NativeFuncData) -> 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.