Struct ra_ap_hir::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 Name holds and prints escaped name i.e. prefixed with “r#” when it is a raw identifier. Use unescaped() when you need the name without “r#”.

Implementations

impl Name

pub fn new_tuple_field(idx: usize) -> Name

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

pub const 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() -> Name

Generates a new name which is only equal to itself, by incrementing a counter. Due its implementation, it should not be used in things that salsa considers, like type names or field names, and it should be only used in names of local variables and labels and similar things.

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

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

pub fn as_text(&self) -> Option<SmolStr>

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

pub fn as_str(&self) -> Option<&str>

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

pub fn to_smol_str(&self) -> SmolStr

Returns the textual representation of this name as a [SmolStr]. Prefer using this over ToString::to_string if possible as this conversion is cheaper in the general case.

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

pub fn is_escaped(&self) -> bool

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

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<(), Error>

Formats the value using the given formatter.

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>(&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 Name

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

Restrict a value to a certain interval.

impl PartialEq for Name

fn eq(&self, other: &Name) -> 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 !=. 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: &Name) -> 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 Eq for Name

impl StructuralEq for Name

impl StructuralPartialEq for Name