Struct texlang::vm::UnexpandedStream

pub struct UnexpandedStream<S>(/* private fields */);

Stream that returns input tokens without performing expansion.

The unexpanded stream is used when reading tokens without performing expansion; e.g., when reading the replacement text for a macro defined using \def.

It be obtained from either the ExecutionInput or the ExpansionInput using the ExpandedStream trait methods.

Trait Implementations

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

type S = S

The type of the custom state in the VM.

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

Gets the next token in the stream or Ok(None) if the stream is exhausted.

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

Returns a reference to the VM.

fn back(&mut self, token: Token)

Returns a token to the front of the token stream.

fn fatal_error<E: TexError>(&mut self, err: E) -> ShutdownSignal

Informs the VM that a fatal error has occurred.

fn error<E: TexError>(&mut self, err: E) -> Result<()>

Informs the VM that a recoverable error has occurred.

fn next_or_err<E: EndOfInputError>(&mut self, err: E) -> Result<Token>

Gets the next token in the stream or error if the stream is exhausted.

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

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.