Struct Primitive 

pub struct Primitive {
    pub cs: Token,
    pub paramlist: Option<Parameters>,
    pub replacement: Option<PrimitiveBody>,
    pub before_digest: Vec<BeforeDigestClosure>,
    pub after_digest: Vec<DigestionClosure>,
    pub alias: Option<String>,
    pub nargs: Option<usize>,
    pub reversion: Option<Reversion>,
    pub is_prefix: bool,
    pub font_id: Option<SymStr>,
}

Fields

cs: Token

paramlist: Option<Parameters>

replacement: Option<PrimitiveBody>

before_digest: Vec<BeforeDigestClosure>

after_digest: Vec<DigestionClosure>

alias: Option<String>

nargs: Option<usize>

reversion: Option<Reversion>

is_prefix: bool

font_id: Option<SymStr>

Set on \font-defined primitives (Perl LaTeXML::Core::Definition::FontDef::fontID). Holds the value-table key under which this CS’s fontinfo hash lives (e.g. \tenrm → Some("fontinfo_\\tenrm")). Lets the dumper round-trip font-defined primitives via Perl’s FD(<cs>) record (see Core/Dumper.pm L356-389) — closures aren’t serializable but the font_id + the dumped Stored::Font value at that key let the reader rebuild an equivalent merge-font Primitive.

Trait Implementations

impl Clone for Primitive

fn clone(&self) -> Primitive

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for Primitive

fn default() -> Self

Returns the “default value” for a type.

impl Definition for Primitive

fn before_digest(&self) -> Option<&Vec<BeforeDigestClosure>>

fn after_digest(&self) -> Option<&Vec<DigestionClosure>>

fn is_prefix(&self) -> bool

fn invoke(&self, _once_only: bool) -> Result<Tokens>

fn invoke_primitive(&self) -> Result<Vec<Digested>>

fn do_absorption( &self, _document: &mut Document, _whatsit: &Whatsit, ) -> Result<Vec<Node>>

fn get_cs(&self) -> Cow<'_, Token>

We can almost always return the CS by reference, except in a Register’s RefCell, where we are forced to clone

fn get_cs_name(&self) -> Cow<'_, str>

fn get_alias(&self) -> Option<&String>

fn get_parameters(&self) -> Option<&Parameters>

fn get_num_args(&self) -> usize

fn get_cs_or_alias(&self) -> Cow<'_, Token>

fn get_sizer(&self) -> Option<SizingClosure>

fn is_protected(&self) -> bool

fn is_register(&self) -> bool

fn is_readonly(&self) -> bool

fn get_test(&self) -> Option<&ConditionalClosure>

fn get_conditional_type(&self) -> Option<ConditionalType>

fn read_arguments(&self) -> Result<Vec<ArgWrap>>

where Self: Sized,

fn invocation( &mut self, args: Vec<Option<Tokens>>, _gullet: &mut Gullet, ) -> Result<Tokens>

fn after_digest_body(&self) -> Option<&Vec<DigestionClosure>>

fn capture_body(&self) -> bool

fn execute_before_digest(&self) -> Result<Vec<Digested>>

fn execute_after_digest(&self, whatsit: &mut Whatsit) -> Result<Vec<Digested>>

fn execute_after_digest_body( &self, whatsit: &mut Whatsit, ) -> Result<Vec<Digested>>

fn value_of(&self, _args: Vec<ArgWrap>) -> Option<RegisterValue>

fn set_value( &self, _value: RegisterValue, _scope: Option<Scope>, _args: Vec<ArgWrap>, )

runs the setter to assign the value for a register

fn register_type(&self) -> Option<RegisterType>

fn get_reversion_spec(&self) -> Option<Reversion>

fn get_expansion(&self) -> Option<&ExpansionBody>

fn stringify_type(&self, deftype: &str) -> String

impl From<Primitive> for Stored

fn from(value: Primitive) -> Self

Converts to this type from the input type.

impl Object for Primitive

fn stringify(&self) -> String

fn isa_box(&self) -> bool

fn is_expandable(&self) -> bool

fn is_definition(&self) -> bool

fn is_comment(&self) -> bool

fn get_locator(&self) -> Option<Locator>

The object’s stored source locator, if it has one. None is the honest “no recorded source position” (replacing the old Locator::default() file!()/line!() sentinel). For “where the parser is now” (error reporting, box creation), use the free fn gullet::get_locator().

fn revert(&self) -> Result<Tokens>

each concrete object needs to provide its own path back to tokens

impl PartialEq for Primitive

fn eq(&self, other: &Primitive) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.