Struct IdentString

pub struct IdentString { /* private fields */ }

A wrapper for an Ident which also keeps the value as a string.

This struct can be used to perform string comparisons and operations.

Implementations

impl IdentString

pub fn new(ident: Ident) -> IdentString

Create a new IdentString.

pub fn as_ident(&self) -> &Ident

Get the ident as a proc_macro2::Ident.

pub fn as_str(&self) -> &str

Get the ident as a string.

pub fn span(&self) -> Span

Get the location of this Ident in source.

pub fn map<F, S>(self, map_fn: F) -> IdentString

where F: FnOnce(String) -> S, S: AsRef<str>,

Apply some transform to the ident’s string representation.

Panics

This will panic if the transform produces an invalid ident.

Trait Implementations

impl AsRef<Ident> for IdentString

fn as_ref(&self) -> &Ident

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<str> for IdentString

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for IdentString

fn clone(&self) -> IdentString

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IdentString

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

Formats the value using the given formatter.

impl Display for IdentString

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

Formats the value using the given formatter.

impl From<Ident> for IdentString

fn from(ident: Ident) -> IdentString

Converts to this type from the input type.

impl From<IdentString> for Ident

fn from(v: IdentString) -> Ident

Converts to this type from the input type.

impl From<IdentString> for String

fn from(v: IdentString) -> String

Converts to this type from the input type.

impl FromMeta for IdentString

fn from_meta(item: &Meta) -> Result<IdentString, Error>

Create an instance from a syn::Meta by dispatching to the format-appropriate trait function. This generally should not be overridden by implementers.

fn from_nested_meta(item: &NestedMeta) -> Result<Self, Error>

fn from_none() -> Option<Self>

When a field is omitted from a parent meta-item, from_none is used to attempt recovery before a missing field error is generated.

fn from_word() -> Result<Self, Error>

Create an instance from the presence of the word in the attribute with no additional options specified.

fn from_list(items: &[NestedMeta]) -> Result<Self, Error>

Create an instance from a list of nested meta items.

fn from_value(value: &Lit) -> Result<Self, Error>

Create an instance from a literal value of either foo = "bar" or foo("bar"). This dispatches to the appropriate method based on the type of literal encountered, and generally should not be overridden by implementers.

fn from_expr(expr: &Expr) -> Result<Self, Error>

fn from_char(value: char) -> Result<Self, Error>

Create an instance from a char literal in a value position.

fn from_string(value: &str) -> Result<Self, Error>

Create an instance from a string literal in a value position.

fn from_bool(value: bool) -> Result<Self, Error>

Create an instance from a bool literal in a value position.

impl Hash for IdentString

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for IdentString

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl<'a> PartialEq<&'a str> for IdentString

fn eq(&self, rhs: &&str) -> 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<String> for IdentString

fn eq(&self, rhs: &String) -> 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 IdentString

fn eq(&self, rhs: &IdentString) -> 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 PartialOrd for IdentString

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl ToTokens for IdentString

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

where Self: Sized,

Convert self directly into a TokenStream object.

impl Eq for IdentString