# Struct syn::Ident

source · [−]

    pub struct Ident { /* private fields */ }

Expand description

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

source

### impl Ident

source

#### 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`.

source

#### 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.

source

#### pub fn span(&self) -> Span

Returns the span of this `Ident`.

source

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

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

## Trait Implementations

source

### impl Clone for Ident

source

#### fn clone(&self) -> Ident

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 Ident

source

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

Formats the value using the given formatter. Read more

source

### impl Display for Ident

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

source

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

Formats the value using the given formatter. Read more

source

### impl From<Crate> for Ident

source

#### fn from(token: Crate) -> Ident

Converts to this type from the input type.

source

### impl From<Extern> for Ident

source

#### fn from(token: Extern) -> Ident

Converts to this type from the input type.

source

### impl From<Ident> for Member

source

#### fn from(ident: Ident) -> Member

Converts to this type from the input type.

source

### impl From<Ident> for TypeParam

source

#### fn from(ident: Ident) -> Self

Converts to this type from the input type.

source

### impl From<SelfType> for Ident

source

#### fn from(token: SelfType) -> Ident

Converts to this type from the input type.

source

### impl From<SelfValue> for Ident

source

#### fn from(token: SelfValue) -> Ident

Converts to this type from the input type.

source

### impl From<Super> for Ident

source

#### fn from(token: Super) -> Ident

Converts to this type from the input type.

source

### impl From<Underscore> for Ident

source

#### fn from(token: Underscore) -> Ident

Converts to this type from the input type.

source

### impl Hash for Ident

source

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

Feeds this value into the given `Hasher`. Read more

1.3.0 · source

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

Feeds a slice of this type into the given `Hasher`. Read more

source

### impl IdentExt for Ident

source

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

Parses any identifier including keywords. Read more

source

#### fn unraw(&self) -> Ident

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

source

#### const peek_any: PeekFn = private::PeekFn

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

source

### impl IdentFragment for Ident

source

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

Span associated with this `IdentFragment`. Read more

source

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

Format this value as an identifier fragment.

source

### impl Ord for Ident

source

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

This method returns an `Ordering` between `self` and `other`. Read more

1.21.0 · source

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

Compares and returns the maximum of two values. Read more

1.21.0 · source

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

Compares and returns the minimum of two values. Read more

1.50.0 · source

#### fn clamp(self, min: Self, max: Self) -> Self where
Self: PartialOrd<Self>,

Restrict a value to a certain interval. Read more

source

### impl Parse for Ident

source

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

source

### impl PartialEq<Ident> for Ident

source

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

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

1.0.0 · source

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

This method tests for `!=`.

source

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

source

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

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

1.0.0 · source

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

This method tests for `!=`.

source

### impl PartialOrd<Ident> for Ident

source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

source

### impl ToTokens for Ident

source

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

Write `self` to the given `TokenStream`. Read more

source

#### fn to_token_stream(&self) -> TokenStream

Convert `self` directly into a `TokenStream` object. Read more

source

#### fn into_token_stream(self) -> TokenStream

Convert `self` directly into a `TokenStream` object. Read more

source

### impl Eq for Ident

source

### impl Token for Ident

## Auto Trait Implementations

### impl RefUnwindSafe for Ident

### impl !Send for Ident

### impl !Sync for Ident

### impl Unpin for Ident

### impl UnwindSafe for Ident

## Blanket Implementations

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,

const: unstable · source

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

### impl<T> From<T> for T

const: unstable · source

#### fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · 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> Spanned for T where
T: Spanned + ?Sized,

source

#### fn span(&self) -> Span

Returns a `Span` covering the complete contents of this syntax tree node, or `Span::call_site()` if this node is empty. Read more

source

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

#### 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> ToString for T where
T: Display + ?Sized,

source

#### default fn to_string(&self) -> String

Converts the given value to a `String`. Read more

source

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

#### type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · 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>,

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

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.