Struct Token 

pub struct Token { /* private fields */ }

A single token.

This struct is written in such a way that it can be passed in registers. The actual representation is TokenRepr, but it should not be accessed directly.

Implementations

impl Token

pub const EOF: Token

The EOF token.

pub const DUMMY: Token

A dummy token that will be thrown away later.

pub const fn new(kind: TokenKind, span: Span) -> Token

Creates a new token.

pub fn from_ast_ident(ident: Ident) -> Token

Recovers a Token from an Ident.

pub fn ident(&self) -> Option<Ident>

Creates a new identifier if the kind is TokenKind::Ident.

pub fn lit(&self) -> Option<TokenLit>

Returns the literal if the kind is TokenKind::Literal.

pub fn lit_kind(&self) -> Option<TokenLitKind>

Returns this token’s literal kind, if any.

pub fn comment(&self) -> Option<(bool, DocComment)>

Returns the comment if the kind is TokenKind::Comment, and whether it’s a doc-comment.

pub fn doc(&self) -> Option<DocComment>

Returns the comment if the kind is TokenKind::Comment.

Does not check that is_doc is true.

pub fn is_op(&self) -> bool

Returns true if the token is an operator.

pub fn as_unop(&self, is_postfix: bool) -> Option<UnOp>

Returns the token as a unary operator, if any.

pub fn as_binop(&self) -> Option<BinOp>

Returns the token as a binary operator, if any.

pub fn as_binop_eq(&self) -> Option<BinOp>

Returns the token as a binary operator, if any.

pub fn is_ident(&self) -> bool

Returns true if the token is an identifier.

pub fn is_lit(&self) -> bool

Returns true if the token is a literal. Includes bool literals.

pub fn is_keyword(&self, kw: Symbol) -> bool

Returns true if the token is a given keyword, kw.

pub fn is_keyword_any(&self, kws: &[Symbol]) -> bool

Returns true if the token is any of the given keywords.

pub fn is_used_keyword(&self) -> bool

Returns true if the token is a keyword used in the language.

pub fn is_unused_keyword(&self) -> bool

Returns true if the token is a keyword reserved for possible future use.

pub fn is_reserved_ident(&self, yul: bool) -> bool

Returns true if the token is a keyword.

pub fn is_non_reserved_ident(&self, yul: bool) -> bool

Returns true if the token is an identifier, but not a keyword.

pub fn is_elementary_type(&self) -> bool

Returns true if the token is an elementary type name.

Note that this does not include [u]fixedMxN types.

pub fn is_bool_lit(&self) -> bool

Returns true if the token is the identifier true or false.

pub fn is_numeric_lit(&self) -> bool

Returns true if the token is a numeric literal.

pub fn is_integer_lit(&self) -> bool

Returns true if the token is the integer literal.

pub fn is_rational_lit(&self) -> bool

Returns true if the token is the rational literal.

pub fn is_str_lit(&self) -> bool

Returns true if the token is a string literal.

pub fn is_ident_where(&self, pred: impl FnOnce(Ident) -> bool) -> bool

Returns true if the token is an identifier for which pred holds.

pub fn is_eof(&self) -> bool

Returns true if the token is an end-of-file marker.

pub fn is_open_delim(&self, d: Delimiter) -> bool

Returns true if the token is the given open delimiter.

pub fn is_close_delim(&self, d: Delimiter) -> bool

Returns true if the token is the given close delimiter.

pub fn is_comment(&self) -> bool

Returns true if the token is a normal comment (not a doc-comment).

pub fn is_comment_or_doc(&self) -> bool

Returns true if the token is a comment or doc-comment.

pub fn is_location_specifier(&self) -> bool

Returns true if the token is a location specifier.

pub fn is_mutability_specifier(&self) -> bool

Returns true if the token is a mutability specifier.

pub fn is_visibility_specifier(&self) -> bool

Returns true if the token is a visibility specifier.

pub fn full_description(&self) -> impl Display

Returns this token’s full description: {self.description()} '{self.kind}'.

pub fn as_str(&self) -> &str

Returns the string representation of the token.

pub fn description(self) -> Option<TokenDescription>

Returns this token’s description, if any.

Trait Implementations

impl Clone for Token

fn clone(&self) -> Token

Returns a duplicate 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<(), Error>

Formats the value using the given formatter.

impl Deref for Token

type Target = TokenRepr

The resulting type after dereferencing.

fn deref(&self) -> &<Token as Deref>::Target

Dereferences the value.

impl DerefMut for Token

fn deref_mut(&mut self) -> &mut <Token as Deref>::Target

Mutably dereferences the value.

impl From<Ident> for Token

fn from(ident: Ident) -> Token

Converts to this type from the input type.

impl PartialEq for Token

fn eq(&self, other: &Token) -> 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 Copy for Token

impl Eq for Token

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 16 bytes