Struct texlang::vm::ExpandedStream

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

A TokenStream that performs expansion.

The unexpanded tokens are retrieved from the unexpanded stream returned by the unexpanded method.

Implementations

impl<S: TexlangState> ExpandedStream<S>

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

Returns the underlying unexpanded stream.

pub fn expand_once(&mut self) -> Result<bool>

Expand the next token in the input.

This method only expands a single token. If, after the expansion, the next token is expandable it will not be expanded.

pub fn checkout_token_buffer(&mut self) -> Vec<Token>

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

Return a token buffer, allowing it to be reused.

pub fn expansions_mut(&mut self) -> &mut Vec<Token>

Returns a mutable reference to the expanded tokens stack for the current input source.

The tokens are a stack, so the next token is the last token in the vector.

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> AsMut<ExpandedStream<S>> for ExpandedStream<S>

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

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

impl<S> AsMut<ExpandedStream<S>> for ExpansionInput<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 ExpandedStream<S>

type S = S

The type of the custom state in the VM.

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

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

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

Returns a reference to the VM.

fn back(&mut self, token: Token)

Returns a token to the front of the token stream.

fn next<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.