Struct Name

pub struct Name {
    pub name: Vec<PathElem>,
}

An item name/path

A name really is a list of strings. However, we sometimes need to introduce unique indices to disambiguate. This mostly happens because of “impl” blocks:

impl<T> List<T> {
  ...
}

A type in Rust can have several “impl” blocks, and those blocks can contain items with similar names. For this reason, we need to disambiguate them with unique indices. Rustc calls those “disambiguators”. In rustc, this gives names like this:

• betree_main::betree::NodeIdCounter{impl#0}::new
• note that impl blocks can be nested, and macros sometimes generate weird names (which require disambiguation): betree_main::betree_utils::_#1::{impl#0}::deserialize::{impl#0}

Finally, the paths used by rustc are a lot more precise and explicit than those we expose in LLBC: for instance, every identifier belongs to a specific namespace (value namespace, type namespace, etc.), and is coupled with a disambiguator.

On our side, we want to stay high-level and simple: we use string identifiers as much as possible, insert disambiguators only when necessary (whenever we find an “impl” block, typically) and check that the disambiguator is useless in the other situations (i.e., the disambiguator is always equal to 0).

Moreover, the items are uniquely disambiguated by their (integer) ids (TypeDeclId, etc.), and when extracting the code we have to deal with name clashes anyway. Still, we might want to be more precise in the future.

Also note that the first path element in the name is always the crate name.

Fields

name: Vec<PathElem>

Implementations

impl Name

pub(crate) fn from_path(path: &[&str]) -> Name

Convert a path like ["std", "alloc", "Box"] to a name. Needed on occasion when crafting names that were not present in the original code.

pub fn len(&self) -> usize

pub fn compare_with_ref_name(&self, equal: bool, ref_name: &[&str]) -> bool

Compare the name to a constant array. This ignores disambiguators.

equal: if true, check that the name is equal to the ref. If false: only check if the ref is a prefix of the name.

pub fn equals_ref_name(&self, ref_name: &[&str]) -> bool

Compare the name to a constant array. This ignores disambiguators.

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<'de> Deserialize<'de> for Name

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Drive for Name

fn drive<V: Visitor>(&self, visitor: &mut V)

impl DriveMut for Name

fn drive_mut<V: VisitorMut>(&mut self, visitor: &mut V)

impl<C: AstFormatter> FmtWithCtx<C> for Name

fn fmt_with_ctx(&self, ctx: &C) -> String

fn fmt_with_ctx_and_indent(&self, _tab: &str, _ctx: &C) -> String

fn with_ctx<'a>(&'a self, ctx: &'a C) -> impl Display + 'a

Returns a struct that implements Display. This allows the following:

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 Serialize for Name

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Name

impl StructuralPartialEq for Name