Struct Name

pub struct Name { /* private fields */ }

Name is a wrapper around string, which is used in hir for both references and declarations. In theory, names should also carry hygiene info, but we are not there yet!

Note that the rawness (r#) of names does not depend on whether they are written raw. This is because we want to show (in completions etc.) names as raw depending on the needs of the current crate, for example if it is edition 2021 complete gen even if the defining crate is in edition 2024 and wrote r#gen, and the opposite holds as well.

Implementations

impl Name

pub fn new(text: &str, ctx: SyntaxContextId) -> Name

pub fn new_tuple_field(idx: usize) -> Name

pub fn new_lifetime(lt: &Lifetime) -> Name

pub fn missing() -> Name

A fake name for things missing in the source code.

For example, impl Foo for {} should be treated as a trait impl for a type with a missing name. Similarly, struct S { : u32 } should have a single field with a missing name.

Ideally, we want a gensym semantics for missing names – each missing name is equal only to itself. It’s not clear how to implement this in salsa though, so we punt on that bit for a moment.

pub fn is_missing(&self) -> bool

Returns true if this is a fake name for things missing in the source code. See missing() for details.

Use this method instead of comparing with Self::missing() as missing names (ideally should) have a gensym semantics.

pub fn generate_new_name(idx: usize) -> Name

Generates a new name that attempts to be unique. Should only be used when body lowering and creating desugared locals and labels. The caller is responsible for picking an index that is stable across re-executions

pub fn as_tuple_index(&self) -> Option<usize>

Returns the tuple index this name represents if it is a tuple field.

pub fn as_str(&self) -> &str

Returns the text this name represents if it isn’t a tuple field.

pub fn unescaped(&self) -> UnescapedName<'_>

pub fn is_escaped(&self, edition: Edition) -> bool

pub fn display<'a>( &'a self, db: &dyn ExpandDatabase, edition: Edition, ) -> impl Display + 'a

pub fn symbol(&self) -> &Symbol

pub const fn new_symbol(symbol: Symbol, ctx: SyntaxContextId) -> Self

pub const fn new_symbol_root(sym: Symbol) -> Self

pub fn eq_ident(&self, ident: &str) -> bool

Trait Implementations

impl Clone for Name

fn clone(&self) -> Name

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Name

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

Formats the value using the given formatter.

impl Extend<Name> for ModPath

fn extend<T: IntoIterator<Item = Name>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl From<Name> for ModPath

fn from(name: Name) -> ModPath

Converts to this type from the input type.

impl Hash for Name

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

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 Name

fn cmp(&self, other: &Self) -> 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 PartialEq<Name> for Symbol

fn eq(&self, name: &Name) -> 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<Symbol> for Name

fn eq(&self, sym: &Symbol) -> 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 Name

fn eq(&self, other: &Name) -> 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 Name

fn partial_cmp(&self, other: &Self) -> 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 ToTokenTree for Name

fn to_token(self, span: Span) -> TokenTree

impl Eq for Name

impl StructuralPartialEq for Name