Skip to main content

NameDef

Struct NameDef 

Source
pub struct NameDef<Ns: NameNamespace> { /* private fields */ }
Expand description

A definition-site leaf name in a semantic namespace.

NameDef<Ns> is intentionally a single NameAtom. It is suitable for names introduced by syntax positions whose namespace is fixed by the grammar, such as type Foo, index Phase, or unit m. Reference positions that may be qualified should stay as NamePath / IdentPath until module-aware resolution can produce a ResolvedName.

Implementations§

Source§

impl<Ns: NameNamespace> NameDef<Ns>

Source

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

Create a new leaf name from a string.

§Panics

Panics if the string is empty or contains .. Use Self::try_new when validating external input.

Source

pub fn try_new(s: impl Into<String>) -> Result<Self, NameAtomError>

Try to create a new leaf name from a string.

§Errors

Returns NameAtomError when the string is empty or contains a path separator.

Source

pub const fn from_atom(atom: NameAtom) -> Self

Create this namespace-specific name from an existing atom.

Source

pub const fn atom(&self) -> &NameAtom

Get the underlying atom.

Source

pub fn as_str(&self) -> &str

Get the underlying string slice.

Source

pub fn into_atom(self) -> NameAtom

Consume and return the inner atom.

Source

pub fn into_inner(self) -> String

Consume and return the inner String.

Source§

impl NameDef<IndexVariant>

Source

pub fn range_step(n: impl Display) -> Self

Build the variant name for the n-th step of a range index (#0, #1, …). Centralises the "#"-prefix format so registry, parser, and evaluator can’t disagree on it.

Source

pub fn qualified_by(&self, index: &IndexName) -> QualifiedIndexVariantName

Pair this variant with its index name for qualified rendering.

Trait Implementations§

Source§

impl<Ns: NameNamespace> AsRef<str> for NameDef<Ns>

Source§

fn as_ref(&self) -> &str

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

impl<Ns: NameNamespace> Borrow<str> for NameDef<Ns>

Source§

fn borrow(&self) -> &str

Immutably borrows from an owned value. Read more
Source§

impl<Ns: Clone + NameNamespace> Clone for NameDef<Ns>

Source§

fn clone(&self) -> NameDef<Ns>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<Ns: NameNamespace> Debug for NameDef<Ns>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<Ns: NameNamespace> Display for NameDef<Ns>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<Ns: Eq + NameNamespace> Eq for NameDef<Ns>

Source§

impl<Ns: NameNamespace> From<&str> for NameDef<Ns>

Source§

fn from(s: &str) -> Self

Converts to this type from the input type.
Source§

impl<Ns: NameNamespace> From<NameAtom> for NameDef<Ns>

Source§

fn from(atom: NameAtom) -> Self

Converts to this type from the input type.
Source§

impl From<NameDef<Decl>> for ScopedName

Source§

fn from(name: DeclName) -> Self

Wrap a DeclName as a local ScopedName. Use this at the resolver → IR boundary where resolver keys (local DeclNames) become IR keys (ScopedNames).

Source§

impl From<NameDef<Index>> for MapEntryIndex

Source§

fn from(value: IndexName) -> Self

Converts to this type from the input type.
Source§

impl From<NameDef<Index>> for NamePath

Source§

fn from(name: IndexName) -> Self

Converts to this type from the input type.
Source§

impl From<NameDef<Unit>> for UnitRef

Source§

fn from(name: UnitName) -> Self

Wrap a bare unit name as a local reference. Definition sites always produce local references; qualified forms are constructed explicitly via UnitRef::qualified.

Source§

impl<Ns: NameNamespace> From<String> for NameDef<Ns>

Source§

fn from(s: String) -> Self

Converts to this type from the input type.
Source§

impl<Ns: Hash + NameNamespace> Hash for NameDef<Ns>

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl<Ns: Ord + NameNamespace> Ord for NameDef<Ns>

Source§

fn cmp(&self, other: &NameDef<Ns>) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 (const: unstable) · Source§

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

Compares and returns the maximum of two values. Read more
1.21.0 (const: unstable) · Source§

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

Compares and returns the minimum of two values. Read more
1.50.0 (const: unstable) · Source§

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

Restrict a value to a certain interval. Read more
Source§

impl<Ns: PartialEq + NameNamespace> PartialEq for NameDef<Ns>

Source§

fn eq(&self, other: &NameDef<Ns>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<Ns: NameNamespace> PartialEq<&str> for NameDef<Ns>

Source§

fn eq(&self, other: &&str) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<Ns: NameNamespace> PartialEq<str> for NameDef<Ns>

Source§

fn eq(&self, other: &str) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<Ns: PartialOrd + NameNamespace> PartialOrd for NameDef<Ns>

Source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 (const: unstable) · Source§

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

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

impl<Ns: NameNamespace> StructuralPartialEq for NameDef<Ns>

Auto Trait Implementations§

§

impl<Ns> Freeze for NameDef<Ns>

§

impl<Ns> RefUnwindSafe for NameDef<Ns>
where Ns: RefUnwindSafe,

§

impl<Ns> Send for NameDef<Ns>
where Ns: Send,

§

impl<Ns> Sync for NameDef<Ns>
where Ns: Sync,

§

impl<Ns> Unpin for NameDef<Ns>
where Ns: Unpin,

§

impl<Ns> UnsafeUnpin for NameDef<Ns>

§

impl<Ns> UnwindSafe for NameDef<Ns>
where Ns: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Comparable<K> for Q
where Q: Ord + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn compare(&self, key: &K) -> Ordering

Compare self to key and return their ordering.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.