Skip to main content

StandardToken

Enum StandardToken 

Source
pub enum StandardToken<Char: Character, CS: CSName<Char>> {
    ControlSequence(CS),
    Character(Char, CommandCode),
    Primitive(PrimitiveIdentifier),
}
Expand description

The simplest (but not most efficient) way to represent a Token as an enum.

Is Copy iff CS is Copy.

Variants§

§

ControlSequence(CS)

§

Character(Char, CommandCode)

§

Primitive(PrimitiveIdentifier)

Trait Implementations§

Source§

impl<Char: Clone + Character, CS: Clone + CSName<Char>> Clone for StandardToken<Char, CS>

Source§

fn clone(&self) -> StandardToken<Char, CS>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<Char: Debug + Character, CS: Debug + CSName<Char>> Debug for StandardToken<Char, CS>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<Char: Character, CS: CSName<Char>> PartialEq for StandardToken<Char, CS>

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl<Char: Character, CS: CSName<Char>> Token for StandardToken<Char, CS>

Source§

type CS = CS

The CSName type used for control sequence names (e.g. Rc<str> or something interned).
Source§

type Char = Char

The Character type for char/catcode-pair tokens.
Source§

fn to_enum(&self) -> StandardToken<Char, CS>

Converts to the canonical enum representation of a token, i.e. StandardToken.
Source§

fn from_cs(cs: CS) -> Self

Create a new token from a control sequence name.
Source§

fn space() -> Self

Create a new space token.
Source§

fn eof() -> Self

Create a new end-of-file token.
Source§

fn from_char_cat(c: Char, cat: CommandCode) -> Self

Create a new character token with given CommandCode (i.e. conceptually the CategoryCode).
Source§

fn primitive(id: PrimitiveIdentifier) -> Self

Create a new token representing a primitive Command.
Source§

fn argument_marker(i: u8) -> Self

Create a new argument marker token. i needs to be in the range 0..=8.
Source§

fn char_value(&self) -> Option<Self::Char>

The Character value of this token, if it is a character token.
Source§

fn command_code(&self) -> CommandCode

The CommandCode (i.e. conceptually the CategoryCode) of this token.
Source§

fn is_cs_or_active(&self) -> bool

Check if this token is a control sequence or an active character
Source§

fn is_cs(&self, name: &Self::CS) -> bool

Check if this token is a control sequence with the given name.
Source§

fn is_primitive(&self) -> Option<PrimitiveIdentifier>

Source§

fn is_argument_marker(&self) -> Option<u8>

Check if this token is a argument token, and if so, return its number (in the range 0..=8).
Source§

fn display_fmt<W: Write>( &self, int: &<Self::CS as CSName<Self::Char>>::Handler, cc: &CategoryCodeScheme<Self::Char>, escapechar: Option<Self::Char>, f: &mut W, ) -> Result

Display this token to a writer, using the given CSHandler (in case it is a control sequence). In that case, we also need the current \escapechar to optionally insert it in front of the control sequence name, and the current CategoryCodeScheme to determine whether or not to insert a space afterwards - which we do unless the control sequence name is a single character with any CommandCode other than Letter.
Source§

fn display<'a>( &'a self, int: &'a <Self::CS as CSName<Self::Char>>::Handler, cc: &'a CategoryCodeScheme<Self::Char>, escapechar: Option<Self::Char>, ) -> DisplayToken<'a, Self>

Returns a helper struct implementing Display for this token.
Source§

impl<Char: Copy + Character, CS: Copy + CSName<Char>> Copy for StandardToken<Char, CS>

Source§

impl<Char: Eq + Character, CS: Eq + CSName<Char>> Eq for StandardToken<Char, CS>

Auto Trait Implementations§

§

impl<Char, CS> Freeze for StandardToken<Char, CS>
where CS: Freeze, Char: Freeze,

§

impl<Char, CS> RefUnwindSafe for StandardToken<Char, CS>
where CS: RefUnwindSafe, Char: RefUnwindSafe,

§

impl<Char, CS> Send for StandardToken<Char, CS>
where CS: Send, Char: Send,

§

impl<Char, CS> Sync for StandardToken<Char, CS>
where CS: Sync, Char: Sync,

§

impl<Char, CS> Unpin for StandardToken<Char, CS>
where CS: Unpin, Char: Unpin,

§

impl<Char, CS> UnsafeUnpin for StandardToken<Char, CS>
where CS: UnsafeUnpin, Char: UnsafeUnpin,

§

impl<Char, CS> UnwindSafe for StandardToken<Char, CS>
where CS: UnwindSafe, Char: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<ET, Err, A> IntoErr<ET, Err> for A
where ET: EngineTypes, Err: From<A>,

Source§

fn into_err( self, _aux: &EngineAux<ET>, _state: &<ET as EngineTypes>::State, ) -> Err

§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

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 T
where U: TryFrom<T>,

Source§

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

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more