Struct rustc_ast::token::Token

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

Fields§

§kind: TokenKind§span: Span

Implementations§

source§

impl Token

source

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

source

pub fn dummy() -> Self

Some token that will be thrown away later.

source

pub fn from_ast_ident(ident: Ident) -> Self

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

source

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.

source

pub fn is_range_separator(&self) -> bool

source

pub fn is_punct(&self) -> bool

source

pub fn is_like_plus(&self) -> bool

source

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.

source

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.

source

pub fn can_begin_type(&self) -> bool

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

source

pub fn can_begin_const_arg(&self) -> bool

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

source

pub fn can_begin_item(&self) -> bool

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

source

pub fn is_lit(&self) -> bool

Returns true if the token is any literal.

source

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.

source

pub fn can_begin_string_literal(&self) -> bool

source

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.

source

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

Returns an identifier if this token is an identifier.

source

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

Returns a lifetime identifier if this token is a lifetime.

source

pub fn is_ident(&self) -> bool

Returns true if the token is an identifier.

source

pub fn is_lifetime(&self) -> bool

Returns true if the token is a lifetime.

source

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

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

source

fn is_whole_path(&self) -> bool

Returns true if the token is an interpolated path.

source

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

source

pub fn is_whole_block(&self) -> bool

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

source

pub fn is_mutability(&self) -> bool

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

source

pub fn is_qpath_start(&self) -> bool

source

pub fn is_path_start(&self) -> bool

source

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

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

source

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.

source

pub fn is_path_segment_keyword(&self) -> bool

source

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.

source

pub fn is_used_keyword(&self) -> bool

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

source

pub fn is_unused_keyword(&self) -> bool

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

source

pub fn is_reserved_ident(&self) -> bool

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

source

pub fn is_bool_lit(&self) -> bool

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

source

pub fn is_numeric_lit(&self) -> bool

source

pub fn is_integer_lit(&self) -> bool

Returns true if the token is the integer literal.

source

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.

source

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

Trait Implementations§

source§

impl Clone for Token

source§

fn clone(&self) -> Token

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Token

source§

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

Formats the value using the given formatter. Read more
source§

impl<__D: SpanDecoder> Decodable<__D> for Token

source§

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

source§

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

source§

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

source§

impl<__CTX> HashStable<__CTX> for Token
where __CTX: HashStableContext,

source§

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

source§

impl PartialEq<TokenKind> for Token

source§

fn eq(&self, rhs: &TokenKind) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PartialEq for Token

source§

fn eq(&self, other: &Token) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl StructuralPartialEq for Token

Auto Trait Implementations§

§

impl Freeze for Token

§

impl !RefUnwindSafe for Token

§

impl !Send for Token

§

impl !Sync for Token

§

impl Unpin for Token

§

impl !UnwindSafe for Token

Blanket Implementations§

source§

impl<T> Aligned for T

source§

const ALIGN: Alignment = _

Alignment of Self.
source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

impl<T> Same for T

source§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

source§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

impl<'a, T> Captures<'a> for T
where T: ?Sized,

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