Struct texlang::vm::ExpandedStream

source ·
#[repr(transparent)]
pub struct ExpandedStream<S>(/* private fields */);
Expand description

A TokenStream that performs expansion.

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

Implementations§

source§

impl<S: TexlangState> ExpandedStream<S>

source

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

Returns the underlying unexpanded stream.

source

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

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.

source

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

source

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

Return a token buffer, allowing it to be reused.

Trait Implementations§

source§

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

source§

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

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

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

source§

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

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

impl<S> AsMut<ExpandedStream<S>> for ExpansionInput<S>

source§

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

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

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

§

type S = S

The type of the custom state in the VM.
source§

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

Gets the next token in the stream. Read more
source§

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

Peeks at the next token in the stream without removing it. Read more
source§

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

Returns a reference to the VM.
source§

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

Consumes the next token in the stream without returning it. Read more
source§

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

Returns a reference to the commands map.
source§

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

Returns a reference to the custom state.
source§

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

source§

fn trace_end_of_input(&self) -> SourceCodeTrace

Auto Trait Implementations§

§

impl<S> !RefUnwindSafe for ExpandedStream<S>

§

impl<S> !Send for ExpandedStream<S>

§

impl<S> !Sync for ExpandedStream<S>

§

impl<S> Unpin for ExpandedStream<S>where S: Unpin,

§

impl<S> UnwindSafe for ExpandedStream<S>where S: UnwindSafe,

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, 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.