Enum Name 

pub enum Name {
    Anonymous,
    Str(Box<Name>, String),
    Num(Box<Name>, u64),
}

A hierarchical name.

Names are used to identify constants, inductives, and other declarations. They form a tree structure: Nat.add.comm is represented as Str(Str(Str(Anonymous, "Nat"), "add"), "comm").

Variants

Anonymous

The anonymous (root) name.

Str(Box<Name>, String)

A string component: parent name + string.

Num(Box<Name>, u64)

A numeric component: parent name + number.

Implementations

impl Name

pub fn str(s: impl Into<String>) -> Self

Create a simple string name (no parent).

pub fn append_str(self, s: impl Into<String>) -> Self

Append a string component to this name.

pub fn append_num(self, n: u64) -> Self

Append a numeric component to this name.

pub fn is_anonymous(&self) -> bool

Check if this is the anonymous name.

pub fn from_str(s: &str) -> Self

Create a Name from a dot-separated string.

Name::from_str("Nat.add.comm") produces the same as Name::str("Nat").append_str("add").append_str("comm").

pub fn depth(&self) -> usize

Returns the depth (number of components) of this name.

Anonymous has depth 0, Name::str("Nat") has depth 1, Name::str("Nat").append_str("add") has depth 2.

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

Return the last string component of this name, if any.

For Nat.add, returns Some("add").

pub fn last_num(&self) -> Option<u64>

Return the last numeric component, if any.

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

Return the root (top-level) component as a string.

For Nat.add.comm, returns "Nat".

pub fn prefix(&self) -> Name

Return the parent name (prefix with last component removed).

pub fn has_prefix(&self, prefix: &Name) -> bool

Check whether this name has prefix as a (strict) prefix.

Nat.add.comm.has_prefix(Nat) is true.

pub fn components(&self) -> Vec<String>

Collect all components from root to leaf.

Returns a vector of (is_num, string_or_num) pairs.

pub fn from_components(comps: &[String]) -> Self

Reconstruct a Name from a list of string components.

Numeric strings are converted to Num components.

pub fn replace_last(self, new_last: impl Into<String>) -> Self

Replace the last string component with new_last.

If the name ends in a numeric component, appends new_last instead.

pub fn freshen(self, suffix: u64) -> Self

Produce a “fresh” version of this name by appending a suffix number.

Used to avoid name collisions during elaboration.

pub fn in_namespace(&self, ns: &Name) -> bool

Check whether this name is in the given namespace.

A name is in namespace ns if it has ns as a strict prefix.

pub fn with_suffix(self, suffix: impl Into<String>) -> Self

Append a suffix string to this name.

pub fn to_ident_string(&self) -> String

Convert to a string suitable for use as a Rust identifier.

Dots and special characters are replaced with underscores.

pub fn prepend(self, prefix: Name) -> Self

Return a new name with the given prefix prepended.

pub fn is_str_name(&self) -> bool

Check whether this name is a string name (last component is a string).

pub fn is_num_name(&self) -> bool

Check whether this name is a numeric name (last component is a number).

Trait Implementations

impl Clone for Name

fn clone(&self) -> Name

Returns a duplicate 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 Default for Name

fn default() -> Name

Returns the “default value” for a type.

impl Display for Name

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

Formats the value using the given formatter.

impl FromIterator<Name> for NameSet

fn from_iter<I: IntoIterator<Item = Name>>(iter: I) -> Self

Creates a value from an iterator.

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

impl StructuralPartialEq for Name