Struct TokenReference

pub struct TokenReference { /* private fields */ }

A reference to a token used by Ast’s. Dereferences to a Token

Implementations

impl TokenReference

pub fn new( leading_trivia: Vec<Token>, token: Token, trailing_trivia: Vec<Token>, ) -> Self

Creates a TokenReference from leading/trailing trivia as well as the leading token

pub fn symbol(text: &str) -> Result<Self, TokenizerErrorType>

Returns a symbol with the leading and trailing whitespace Only whitespace is supported

let symbol = TokenReference::symbol("\nreturn ")?;
assert_eq!(symbol.leading_trivia().next().unwrap().to_string(), "\n");
assert_eq!(symbol.token().token_type(), &TokenType::Symbol {
    symbol: Symbol::Return,
});
assert_eq!(symbol.trailing_trivia().next().unwrap().to_string(), " ");
assert!(TokenReference::symbol("isnt whitespace").is_err());
assert!(TokenReference::symbol(" notasymbol ").is_err());

pub fn symbol_specific_lua_version( text: &str, lua_version: LuaVersion, ) -> Result<Self, TokenizerErrorType>

Returns a symbol with the leading and trailing whitespace, much like TokenReference::symbol, but only if it’s valid for the given Lua version. ```rust # use full_moon::tokenizer::{Symbol, TokenReference, TokenType, TokenizerErrorType}; # use full_moon::LuaVersion; # fn main() -> Result<(), Box> { assert!(TokenReference::symbol_specific_lua_version(“goto”, LuaVersion::lua51()).is_err()); assert!(TokenReference::symbol_specific_lua_version(“goto”, LuaVersion::lua52()).is_ok()); # Ok(()) # }

pub fn token(&self) -> &Token

Returns the inner token.

pub fn leading_trivia(&self) -> impl Iterator<Item = &Token>

Returns the leading trivia

pub fn trailing_trivia(&self) -> impl Iterator<Item = &Token>

Returns the trailing trivia

pub fn with_token(&self, token: Token) -> Self

Creates a clone of the current TokenReference with the new inner token, preserving trivia.

pub fn is_symbol(&self, symbol: Symbol) -> bool

Checks if the token is the given symbol

Methods from Deref<Target = Token>

pub fn start_position(&self) -> Position

The position a token begins at

pub fn end_position(&self) -> Position

The position a token ends at

pub fn token_type(&self) -> &TokenType

The type of token as well as the data needed to represent it If you don’t need any other information, use token_kind instead.

pub fn token_kind(&self) -> TokenKind

The kind of token with no additional data. If you need any information such as idenitfier names, use token_type instead.

Trait Implementations

impl Borrow<Token> for &TokenReference

fn borrow(&self) -> &Token

Immutably borrows from an owned value.

impl Clone for TokenReference

fn clone(&self) -> TokenReference

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TokenReference

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

Formats the value using the given formatter.

impl Deref for TokenReference

type Target = Token

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'de> Deserialize<'de> for TokenReference

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for TokenReference

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

Formats the value using the given formatter.

impl Node for TokenReference

fn start_position(&self) -> Option<Position>

The start position of a node. None if can’t be determined

fn end_position(&self) -> Option<Position>

The end position of a node. None if it can’t be determined

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

Whether another node of the same type is the same as this one semantically, ignoring position

fn tokens(&self) -> Tokens<'_>

The token references that comprise a node

fn range(&self) -> Option<(Position, Position)>

The full range of a node, if it has both start and end positions

fn surrounding_trivia(&self) -> (Vec<&Token>, Vec<&Token>)

The tokens surrounding a node that are ignored and not accessible through the node’s own accessors. Use this if you want to get surrounding comments or whitespace. Returns a tuple of the leading and trailing trivia.

impl Ord for TokenReference

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for TokenReference

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 PartialOrd for TokenReference

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for TokenReference

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for TokenReference