Struct texlang::vm::ExecutionInput

#[repr(transparent)]
pub struct ExecutionInput<S>(/* private fields */);

Input type for execution primitives.

This type provides:

• Access to the input stream (with or without expansion). Its implementation of the TokenStream trait returns expanded tokens. To read the input stream without performing expansion, use the unexpanded method.

• Mutable access to the state and the commands map the ExecutionInput::state_mut and ExecutionInput::commands_map_mut methods.

Implementations

impl<S> ExecutionInput<S>

pub fn new(vm: &mut VM<S>) -> &mut ExecutionInput<S>

Creates a mutable reference to this type from the VM type.

pub fn unexpanded(&mut self) -> &mut UnexpandedStream<S>

pub fn commands_map_mut(&mut self) -> &mut Map<S>

pub fn state_mut(&mut self) -> &mut S

Returns a mutable reference to the state.

pub fn tracer_mut(&mut self) -> &mut Tracer

Returns a mutable reference to the tracer.

pub fn vm_parts(&mut self) -> Parts<'_, S>

Returns a vm::Parts struct contains mutable references to different parts of the VM.

pub fn begin_group(&mut self)

pub fn end_group(&mut self, token: Token) -> Result<(), Box<Error>>

pub fn return_token_buffer(&mut self, token_buffer: Vec<Token>)

Return a token buffer, allowing it to be reused.

Trait Implementations

impl<S> AsMut<ExpandedStream<S>> for ExecutionInput<S>

fn as_mut(&mut self) -> &mut ExpandedStream<S>

Converts this type into a mutable reference of the (usually inferred) input type.

impl<S: TexlangState> TokenStream for ExecutionInput<S>

type S = S

The type of the custom state in the VM.

fn next(&mut self) -> Result<Option<Token>, Box<Error>>

Gets the next token in the stream.

fn peek(&mut self) -> Result<Option<&Token>, Box<Error>>

Peeks at the next token in the stream without removing it.

fn vm(&self) -> &VM<Self::S>

Returns a reference to the VM.

fn consume(&mut self) -> Result<(), Box<Error>>

Consumes the next token in the stream without returning it.

fn commands_map(&self) -> &Map<Self::S>

Returns a reference to the commands map.

fn state(&self) -> &Self::S

Returns a reference to the custom state.

fn trace(&self, token: Token) -> SourceCodeTrace

fn trace_end_of_input(&self) -> SourceCodeTrace