Struct texlang::command::BuiltIn

source ·
pub struct BuiltIn<S> { /* private fields */ }
Expand description

A built-in command. This is a command provided at VM initialization.

This struct is simply a combination of a Command and a documentation string for the command. It is used when providing the built-in commands for a VM.

Implementations§

source§

impl<S> BuiltIn<S>

source

pub fn new_expansion(t: ExpansionFn<S>) -> BuiltIn<S>

Create a new expansion built-in command.

source

pub fn new_execution(t: ExecutionFn<S>) -> BuiltIn<S>

Create a new expansion built-in command.

source

pub fn new_variable(cmd: Command<S>) -> BuiltIn<S>

Create a new variable built-in command.

source

pub fn with_tag(self, tag: Tag) -> BuiltIn<S>

Set the tag for this built-in command.

source

pub fn with_doc(self, doc: &'static str) -> BuiltIn<S>

source

pub fn cmd(&self) -> &Command<S>

source

pub fn doc(&self) -> Option<&'static str>

Trait Implementations§

source§

impl<S> Clone for BuiltIn<S>

source§

fn clone(&self) -> Self

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl<S> From<Command<S>> for BuiltIn<S>

source§

fn from(cmd: Command<S>) -> Self

Converts to this type from the input type.
source§

impl<S> From<Command<S>> for BuiltIn<S>

source§

fn from(cmd: Command<S>) -> Self

Converts to this type from the input type.
source§

impl<S> From<Rc<Macro, Global>> for BuiltIn<S>

source§

fn from(cmd: Rc<Macro>) -> Self

Converts to this type from the input type.
source§

impl<S> From<fn(_: Token, _: &mut ExecutionInput<S>) -> Result<(), Box<Error, Global>>> for BuiltIn<S>

source§

fn from(cmd: ExecutionFn<S>) -> Self

Converts to this type from the input type.
source§

impl<S> From<fn(_: Token, _: &mut ExpansionInput<S>) -> Result<(), Box<Error, Global>>> for BuiltIn<S>

source§

fn from(cmd: ExpansionFn<S>) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

§

impl<S> RefUnwindSafe for BuiltIn<S>

§

impl<S> !Send for BuiltIn<S>

§

impl<S> !Sync for BuiltIn<S>

§

impl<S> Unpin for BuiltIn<S>

§

impl<S> UnwindSafe for BuiltIn<S>

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.