Struct TokenWithSourceref

pub struct TokenWithSourceref<C: CharType> {
    pub base: BaseToken<C>,
    pub sourceref: Option<SourceReference<Self>>,
}

A Token bundling a BaseToken with a SourceReference.

Fields

base: BaseToken<C>

The actual TeX-relevant data of the Token

sourceref: Option<SourceReference<Self>>

The SourceReference of the Token

Trait Implementations

impl<C: Clone + CharType> Clone for TokenWithSourceref<C>

fn clone(&self) -> TokenWithSourceref<C>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: CharType> Debug for TokenWithSourceref<C>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<C: CharType> Display for TokenWithSourceref<C>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<Char: CharType> Mouth<TokenWithSourceref<Char>> for TracingMouth<Char>

fn new() -> Self

fn push_tokens(&mut self, tks: Vec<TokenWithSourceref<Char>>)

Insert a Vec of Tokens into the Mouth, to be processed next

fn push_file<F: File<Char>>(&mut self, file: &F)

Insert a File into the Mouth, to be processed next

fn requeue(&mut self, tk: TokenWithSourceref<Char>)

Insert a single Token into the Mouth, to be processed next (for implementations with a peek buffer)

fn has_next<S: State<TokenWithSourceref<Char>>>( &mut self, state: &S, ) -> Result<bool, InvalidCharacter<TokenWithSourceref<Char>>>

fn get_next<S: State<TokenWithSourceref<Char>>>( &mut self, s: &S, ) -> Result<Option<(TokenWithSourceref<Char>, bool)>, InvalidCharacter<TokenWithSourceref<Char>>>

Return the next Token from the Mouth, and whether to expand it (due to \noexpand)

fn preview(&self, len: usize) -> String

Return the next n characters from the Mouth as a String, without consuming them (for error messages, debugging purposes, etc.)

fn file_line(&self) -> String

Return the current file and line number as presentable string

fn get_next_nopar<S: State<T>>( &mut self, state: &S, ) -> Result<Option<(T, bool)>, Box<dyn TeXError<T>>>

like get_next, but throws an error on \par (and EOF)

fn skip_whitespace<S: State<T>>( &mut self, state: &S, ) -> Result<(), InvalidCharacter<T>>

Skip whitespace characters from the Mouth

fn skip_eq_char<S: State<T>>( &mut self, state: &S, ) -> Result<(), InvalidCharacter<T>>

read optional = characters from the Mouth

fn read_argument<S: State<T>>( &mut self, state: &S, ) -> Result<Vec<T>, Box<dyn TeXError<T>>>

reads a macro argument from the Mouth, i.e. a sequence of Tokens enclosed in braces (category codes BeginGroup and EndGroup), or a single non-space Token if the argument is not enclosed.

fn read_argument_nopar<S: State<T>>( &mut self, state: &S, ) -> Result<Vec<T>, Box<dyn TeXError<T>>>

Like read_argument, but throws an error on \par (and EOF)

fn read_until_endgroup<S: State<T>>( &mut self, state: &S, ) -> Result<Vec<T>, Box<dyn TeXError<T>>>

reads Tokens from the Mouth until the next suitable EndGroup Token is encountered, and returns them as a Vec, respecting nested groups.

impl<C: CharType> PartialEq for TokenWithSourceref<C>

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<C: CharType> Token for TokenWithSourceref<C>

type Char = C

fn base(&self) -> &BaseToken<C>

The actual TeX-relevant data of the Token

fn new( base: BaseToken<C>, sourceref: Option<(Ptr<String>, (usize, usize), (usize, usize))>, ) -> Self

Construct a new Token from a BaseToken

fn with_ref(&self, token: &Ptr<Self>, cmd: &Ptr<Command<Self>>) -> Self

Clone this Token with a new SourceReference of type SourceReference::Expansion (if the Token is a TokenWithSourceref).

fn sourceref_trace(&self) -> Option<String>

fn from_str(s: String) -> Vec<Self>

Parse a string into a list of Tokens of CategoryCode::Other

fn catcode(&self) -> CategoryCode

The CategoryCode of the Token