Struct rustc_ast::token::Token

pub struct Token {
    pub kind: TokenKind,
    pub span: Span,
}

Fields

kind: TokenKind

span: Span

Implementations

impl Token

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

pub fn dummy() -> Self

Some token that will be thrown away later.

pub fn from_ast_ident(ident: Ident) -> Self

Recovers a Token from an Ident. This creates a raw identifier if necessary.

pub fn uninterpolated_span(&self) -> Span

For interpolated tokens, returns a span of the fragment to which the interpolated token refers. For all other tokens this is just a regular span. It is particularly important to use this for identifiers and lifetimes for which spans affect name resolution and edition checks. Note that keywords are also identifiers, so they should use this if they keep spans or perform edition checks.

pub fn is_range_separator(&self) -> bool

pub fn is_punct(&self) -> bool

pub fn is_like_plus(&self) -> bool

pub fn can_begin_expr(&self) -> bool

Returns true if the token can appear at the start of an expression.

NB: Take care when modifying this function, since it will change the stable set of tokens that are allowed to match an expr nonterminal.

pub fn can_begin_pattern(&self, pat_kind: NtPatKind) -> bool

Returns true if the token can appear at the start of a pattern.

Shamelessly borrowed from can_begin_expr, only used for diagnostics right now.

pub fn can_begin_type(&self) -> bool

Returns true if the token can appear at the start of a type.

pub fn can_begin_const_arg(&self) -> bool

Returns true if the token can appear at the start of a const param.

pub fn can_begin_item(&self) -> bool

Returns true if the token can appear at the start of an item.

pub fn is_lit(&self) -> bool

Returns true if the token is any literal.

pub fn can_begin_literal_maybe_minus(&self) -> bool

Returns true if the token is any literal, a minus (which can prefix a literal, for example a ‘-42’, or one of the boolean idents).

In other words, would this token be a valid start of parse_literal_maybe_minus?

Keep this in sync with and Lit::from_token, excluding unary negation.

pub fn can_begin_string_literal(&self) -> bool

pub fn uninterpolate(&self) -> Cow<'_, Token>

A convenience function for matching on identifiers during parsing. Turns interpolated identifier ($i: ident) or lifetime ($l: lifetime) token into the regular identifier or lifetime token it refers to, otherwise returns the original token.

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

Returns an identifier if this token is an identifier.

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

Returns a lifetime identifier if this token is a lifetime.

pub fn is_ident(&self) -> bool

Returns true if the token is an identifier.

pub fn is_lifetime(&self) -> bool

Returns true if the token is a lifetime.

pub fn is_ident_named(&self, name: Symbol) -> bool

Returns true if the token is an identifier whose name is the given string slice.

fn is_whole_path(&self) -> bool

Returns true if the token is an interpolated path.

pub fn is_whole_expr(&self) -> bool

Is this a pre-parsed expression dropped into the token stream (which happens while parsing the result of macro expansion)?

pub fn is_whole_block(&self) -> bool

Is the token an interpolated block ($b:block)?

pub fn is_mutability(&self) -> bool

Returns true if the token is either the mut or const keyword.

pub fn is_qpath_start(&self) -> bool

pub fn is_path_start(&self) -> bool

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

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

pub fn is_keyword_case(&self, kw: Symbol, case: Case) -> bool

Returns true if the token is a given keyword, kw or if case is Insensitive and this token is an identifier equal to kw ignoring the case.

pub fn is_path_segment_keyword(&self) -> bool

pub fn is_special_ident(&self) -> bool

Returns true for reserved identifiers used internally for elided lifetimes, unnamed method parameters, crate root module, error recovery etc.

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) -> bool

Returns true if the token is either a special identifier or a keyword.

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

pub fn is_integer_lit(&self) -> bool

Returns true if the token is the integer literal.

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

Returns true if the token is a non-raw identifier for which pred holds.

pub fn glue(&self, joint: &Token) -> Option<Token>

Trait Implementations

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<__D: SpanDecoder> Decodable<__D> for Token

fn decode(__decoder: &mut __D) -> Self

impl<__E: SpanEncoder> Encodable<__E> for Token

fn encode(&self, __encoder: &mut __E)

impl<__CTX> HashStable<__CTX> for Token

where __CTX: HashStableContext,

fn hash_stable(&self, __hcx: &mut __CTX, __hasher: &mut StableHasher)

impl PartialEq<TokenKind> for Token

fn eq(&self, rhs: &TokenKind) -> 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 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 StructuralPartialEq 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: 24 bytes