Struct FunctionSpec 

pub struct FunctionSpec {
    pub node_type: Option<NodeType>,
    pub num_args: usize,
    pub arg_types: Option<Vec<ArgType>>,
    pub allowed_in_argument: bool,
    pub allowed_in_text: bool,
    pub allowed_in_math: bool,
    pub num_optional_args: usize,
    pub infix: bool,
    pub primitive: bool,
    pub handler: Option<FunctionHandler>,
}

Runtime function specification used during LaTeX parsing and processing.

Fields

node_type: Option<NodeType>

Function type name (equivalent to type in KaTeX)

num_args: usize

Number of arguments

arg_types: Option<Vec<ArgType>>

Argument types

allowed_in_argument: bool

Allowed in argument position

allowed_in_text: bool

Allowed in text mode

allowed_in_math: bool

Allowed in math mode

num_optional_args: usize

Number of optional arguments

infix: bool

Infix operator

primitive: bool

TeX primitive

handler: Option<FunctionHandler>

Handler function

Trait Implementations

impl Clone for FunctionSpec

fn clone(&self) -> FunctionSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FunctionSpec

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

Formats the value using the given formatter.

impl Spec for FunctionSpec

fn num_args(&self) -> usize

Returns the number of arguments required.

fn num_optional_args(&self) -> usize

Returns the number of optional arguments.

fn arg_types(&self) -> Option<&Vec<ArgType>>

Returns the argument types if specified.

fn primitive(&self) -> bool

Returns true if the spec is primitive.

fn node_type(&self) -> Option<&NodeType>

Returns the node type if specified.