Struct Token

pub struct Token {
    s: &'static str,
    pub loc: Loc,
}

A Token consists of a string and its location in the parsed files.

Fields

s: &'static str

loc: Loc

Implementations

impl Token

pub fn new(s: &str, loc: Loc) -> Self

pub fn from_static_str(s: &'static str, loc: Loc) -> Self

pub fn subtoken<R>(&self, range: R, loc: Loc) -> Token

where R: RangeBounds<usize> + SliceIndex<str, Output = str>,

Create a Token from a substring of the given Token.

pub fn subtoken_stripped(&self, range: Range<usize>, loc: Loc) -> Token

Create a Token from a subtring of the given Token, stripping any whitespace from the created token.

pub fn as_str(&self) -> &'static str

pub fn is(&self, s: &str) -> bool

pub fn lowercase_is(&self, s: &str) -> bool

pub fn starts_with(&self, s: &str) -> bool

pub fn split(&self, ch: char) -> Vec<Token>

Split the token into one or more subtokens, with ch as the delimiter. Updates the locs for the created subtokens. This is not meant for multiline tokens.

Panics

May panic if the token’s column location exceeds 4,294,967,296.

pub fn strip_suffix(&self, sfx: &str) -> Option<Token>

pub fn strip_prefix(&self, pfx: &str) -> Option<Token>

pub fn split_once(&self, ch: char) -> Option<(Token, Token)>

Split the token into two subtokens, with the split at the first occurrence of ch. Updates the locs for the created subtokens. This is not meant for multiline tokens. Returns None if ch was not found in the token.

Panics

May panic if the token’s column location exceeds 4,294,967,296.

pub fn split_after(&self, ch: char) -> Option<(Token, Token)>

Split the token into two subtokens, with the split at the first instance of ch, such that ch is part of the first returned token. Updates the locs for the created subtokens. This is not meant for multiline tokens. Returns None if ch was not found in the token.

Panics

May panic if the token’s column location exceeds 4,294,967,296.

pub fn combine(&mut self, other: &Token, c: char)

Create a new token that is a concatenation of this token and other, with c between them.

pub fn trim(&self) -> Token

Return a subtoken of this token, such that all whitespace is removed from the start and end. Will update the loc of the subtoken. This is not meant for multiline tokens.

Panics

May panic if the token’s column location exceeds 4,294,967,296.

pub fn expect_number(&self) -> Option<f64>

pub fn get_fixed_number(&self) -> Option<i64>

Gets the field as a fixed-width decimal, specifically the value multiplied by 100,000

pub fn get_number(&self) -> Option<f64>

pub fn is_number(&self) -> bool

pub fn check_number(&self)

pub fn expect_precise_number(&self) -> Option<f64>

Some files seem not to have the 5-decimal limitation

pub fn expect_integer(&self) -> Option<i64>

pub fn get_integer(&self) -> Option<i64>

pub fn is_integer(&self) -> bool

pub fn expect_date(&self) -> Option<Date>

pub fn get_date(&self) -> Option<Date>

pub fn is_date(&self) -> bool

pub fn linked(self, link_idx: Option<MacroMapIndex>) -> Self

Trait Implementations

impl Borrow<str> for &Token

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl Borrow<str> for Token

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl Clone for Token

fn clone(&self) -> Token

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Token

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

Formats the value using the given formatter.

impl Display for Token

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

Formats the value using the given formatter.

impl ErrorLoc for &Token

fn loc_length(&self) -> usize

fn into_loc(self) -> Loc

impl ErrorLoc for Token

fn loc_length(&self) -> usize

fn into_loc(self) -> Loc

impl From<&Token> for Token

fn from(token: &Token) -> Token

Converts to this type from the input type.

impl From<Loc> for Token

fn from(loc: Loc) -> Self

Converts to this type from the input type.

impl Hash for Token

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Token

Tokens are compared for equality regardless of their loc.

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 TryFrom<&Token> for Date

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &Token) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&Token> for Tier

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &Token) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Token> for Tier

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Token) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for Token