Struct syn::Ident

pub struct Ident { /* private fields */ }

A word of Rust code, which may be a keyword or legal variable name.

An identifier consists of at least one Unicode code point, the first of which has the XID_Start property and the rest of which have the XID_Continue property.

• The empty string is not an identifier. Use Option<Ident>.
• A lifetime is not an identifier. Use syn::Lifetime instead.

An identifier constructed with Ident::new is permitted to be a Rust keyword, though parsing one through its Parse implementation rejects Rust keywords. Use input.call(Ident::parse_any) when parsing to match the behaviour of Ident::new.

Examples

A new ident can be created from a string using the Ident::new function. A span must be provided explicitly which governs the name resolution behavior of the resulting identifier.

use proc_macro2::{Ident, Span};

fn main() {
    let call_ident = Ident::new("calligraphy", Span::call_site());

    println!("{}", call_ident);
}

An ident can be interpolated into a token stream using the quote! macro.

use proc_macro2::{Ident, Span};
use quote::quote;

fn main() {
    let ident = Ident::new("demo", Span::call_site());

    // Create a variable binding whose name is this ident.
    let expanded = quote! { let #ident = 10; };

    // Create a variable binding with a slightly different name.
    let temp_ident = Ident::new(&format!("new_{}", ident), Span::call_site());
    let expanded = quote! { let #temp_ident = 10; };
}

A string representation of the ident is available through the to_string() method.

// Examine the ident as a string.
let ident_string = ident.to_string();
if ident_string.len() > 60 {
    println!("Very long identifier: {}", ident_string)
}

Implementations

impl Ident

pub fn new(string: &str, span: Span) -> Ident

Creates a new Ident with the given string as well as the specified span.

The string argument must be a valid identifier permitted by the language, otherwise the function will panic.

Note that span, currently in rustc, configures the hygiene information for this identifier.

As of this time Span::call_site() explicitly opts-in to “call-site” hygiene meaning that identifiers created with this span will be resolved as if they were written directly at the location of the macro call, and other code at the macro call site will be able to refer to them as well.

Later spans like Span::def_site() will allow to opt-in to “definition-site” hygiene meaning that identifiers created with this span will be resolved at the location of the macro definition and other code at the macro call site will not be able to refer to them.

Due to the current importance of hygiene this constructor, unlike other tokens, requires a Span to be specified at construction.

Panics

Panics if the input string is neither a keyword nor a legal variable name. If you are not sure whether the string contains an identifier and need to handle an error case, use syn::parse_str::<Ident> rather than Ident::new.

pub fn new_raw(string: &str, span: Span) -> Ident

Same as Ident::new, but creates a raw identifier (r#ident). The string argument must be a valid identifier permitted by the language (including keywords, e.g. fn). Keywords which are usable in path segments (e.g. self, super) are not supported, and will cause a panic.

pub fn span(&self) -> Span

Returns the span of this Ident.

pub fn set_span(&mut self, span: Span)

Configures the span of this Ident, possibly changing its hygiene context.

Trait Implementations

impl Clone for Ident

fn clone(&self) -> Ident

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Ident

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

Formats the value using the given formatter.

impl Display for Ident

Prints the identifier as a string that should be losslessly convertible back into the same identifier.

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

Formats the value using the given formatter.

impl From<Crate> for Ident

fn from(token: Crate) -> Ident

Converts to this type from the input type.

impl From<Extern> for Ident

fn from(token: Extern) -> Ident

Converts to this type from the input type.

impl From<Ident> for Member

fn from(ident: Ident) -> Member

Converts to this type from the input type.

impl From<Ident> for TypeParam

fn from(ident: Ident) -> Self

Converts to this type from the input type.

impl From<SelfType> for Ident

fn from(token: SelfType) -> Ident

Converts to this type from the input type.

impl From<SelfValue> for Ident

fn from(token: SelfValue) -> Ident

Converts to this type from the input type.

impl From<Super> for Ident

fn from(token: Super) -> Ident

Converts to this type from the input type.

impl From<Underscore> for Ident

fn from(token: Underscore) -> Ident

Converts to this type from the input type.

impl Hash for Ident

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl IdentExt for Ident

fn parse_any(input: ParseStream<'_>) -> Result<Self>

Parses any identifier including keywords.

fn unraw(&self) -> Ident

Strips the raw marker r#, if any, from the beginning of an ident.

const peek_any: PeekFn = private::PeekFn

Peeks any identifier including keywords. Usage: input.peek(Ident::peek_any)

impl IdentFragment for Ident

fn span(&self) -> Option<Span>

Span associated with this IdentFragment.

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

Format this value as an identifier fragment.

impl Ord for Ident

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl Parse for Ident

fn parse(input: ParseStream<'_>) -> Result<Self>

impl PartialEq<Ident> for Ident

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl<T> PartialEq<T> for Ident where
    T: AsRef<str> + ?Sized, 

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<Ident> for Ident

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl ToTokens for Ident

fn to_tokens(&self, tokens: &mut TokenStream)

Write self to the given TokenStream.

fn to_token_stream(&self) -> TokenStream

Convert self directly into a TokenStream object.

fn into_token_stream(self) -> TokenStream

Convert self directly into a TokenStream object.

impl Eq for Ident

impl Token for Ident