Enum jomini::TextToken

pub enum TextToken<'a> {
    Array(usize),
    Object(usize),
    HiddenObject(usize),
    Scalar(Scalar<'a>),
    Operator(Operator),
    End(usize),
    Header(Scalar<'a>),
}

Represents a valid text value

Variants

Array(usize)

Index of the TextToken::End that signifies this array's termination

Object(usize)

Index of the TextToken::End that signifies this objects's termination

Typically in the tape the value immediately follows a key token. However, this is not guaranteed so always check if the end has been reached before trying to decode a value. There are two main situations where this is not guaranteed:

• A non-equal operator (eg: a > b will be parsed to 3 instead of 2 tokens)
• Array trailers (eg: a = {10} 0 1 2)

HiddenObject(usize)

Index of the TextToken::End that signifies this objects's termination

A hidden object occurs where the first element is part of an array:

a = { 10 a=b c=d}

In the above example, a and c would be part of the hidden object

Scalar(Scalar<'a>)

Extracted scalar value

Operator(Operator)

A present, but non-equal operator token

End(usize)

Index of the start of this object

Header(Scalar<'a>)

The header token of the subsequent scalar. For instance, given

color = rgb { 100 200 50 }

rgb would be a the header followed by a 3 element array

Trait Implementations

impl<'a> Debug for TextToken<'a>

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

Formats the value using the given formatter.

impl<'a> PartialEq<TextToken<'a>> for TextToken<'a>

fn eq(&self, other: &TextToken<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &TextToken<'a>) -> bool

This method tests for !=.

impl<'a> StructuralPartialEq for TextToken<'a>