proc_macro::Ident - Rust
Description: API documentation for the Rust `Ident` struct in crate `proc_macro`.
Keywords: rust, rustlang, rust-lang, Ident

# 1.29.0[−][src]Struct proc_macro::Ident

    pub struct Ident { /* fields omitted */ }

An identifier (`ident`).

## Methods

###

`impl Ident`

[src]

####

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

[src]

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.

####

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

[src]

🔬 This is a nightly-only experimental API. (`proc_macro_raw_ident` #54723)

Same as `Ident::new`, but creates a raw identifier (`r#ident`).

####

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

[src]

Returns the span of this `Ident`, encompassing the entire string returned by `as_str`.

####

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

[src]

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

## Trait Implementations

###

`impl Clone for Ident`

[src]

####

`fn clone(&self) -> Ident`

[src]

Returns a copy of the value. Read more

####

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

1.0.0
[src]

Performs copy-assignment from `source`. Read more

###

`impl From<Ident> for TokenTree`

[src]

####

`fn from(g: Ident) -> TokenTree`

[src]

Performs the conversion.

###

`impl !Send for Ident`

[src]

###

`impl !Sync for Ident`

[src]

###

`impl Display for Ident`

[src]

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

####

`fn fmt(&self, f: &mut Formatter) -> Result`

[src]

Formats the value using the given formatter. Read more

###

`impl Debug for Ident`

[src]

####

`fn fmt(&self, f: &mut Formatter) -> Result`

[src]

Formats the value using the given formatter. Read more

## Blanket Implementations

###

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

[src]

#### `type Owned = T`

####

`fn to_owned(&self) -> T`

[src]

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

####

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

[src]

🔬 This is a nightly-only experimental API. (`toowned_clone_into` #41263)

recently added

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

###

`impl<T> ToString for T where T: Display + ?Sized,`

[src]

####

`fn to_string(&self) -> String`

[src]

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

###

`impl<T> From for T`

[src]

####

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

[src]

Performs the conversion.

###

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

[src]

####

`fn into(self) -> U`

[src]

Performs the conversion.

###

`impl<T, U> TryFrom for T where T: From<U>,`

[src]

#### `type Error = !`

🔬 This is a nightly-only experimental API. (`try_from` #33417)

The type returned in the event of a conversion error.

####

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

[src]

🔬 This is a nightly-only experimental API. (`try_from` #33417)

Performs the conversion.

###

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

[src]

####

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

[src]

Immutably borrows from an owned value. Read more

###

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

[src]

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

🔬 This is a nightly-only experimental API. (`try_from` #33417)

The type returned in the event of a conversion error.

####

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

[src]

🔬 This is a nightly-only experimental API. (`try_from` #33417)

Performs the conversion.

###

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

[src]

####

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

[src]

Mutably borrows from an owned value. Read more

###

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

[src]

####

`fn get_type_id(&self) -> TypeId`

[src]

🔬 This is a nightly-only experimental API. (`get_type_id` #27745)

this method will likely be replaced by an associated static

Gets the `TypeId` of `self`. Read more

###

`impl<E> SpecializationError for E`

[src]

####

`fn not_found<S, T>(trait_name: &'static str, method_name: &'static str) -> E where T: ?Sized,`

[src]

🔬 This is a nightly-only experimental API. (`rustc_private` #27812)

this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via `Cargo.toml` instead?

Create an error for a missing method specialization. Defaults to panicking with type, trait & method names. `S` is the encoder/decoder state type, `T` is the type being encoded/decoded, and the arguments are the names of the trait and method that should've been overridden. Read more

###

`impl<T> Erased for T`

[src]

###

`impl<T> Send for T where T: ?Sized,`

[src]

###

`impl<T> Sync for T where T: ?Sized,`

[src]

###

`impl<T> Erased for T`

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g. `str,u8` or `String,struct:Vec,test`)