Struct UnitRef 

pub struct UnitRef { /* private fields */ }

A unit reference, optionally qualified by a module alias.

Unit references follow the same scoping rules as every other imported category: a bare name (mile) refers to a local declaration, a selective import, or a prelude unit; a qualified name (u.mile) refers to a pub unit of the module imported as u. The qualifier is at most one module alias — unit references never nest deeper.

The Display impl renders u.mile / mile for diagnostics and formatting boundaries only; the compiler core matches on the typed parts.

Implementations

impl UnitRef

pub fn local(name: impl Into<UnitName>) -> Self

Create an unqualified (file-local, selective-import, or prelude) unit reference.

pub const fn qualified(qualifier: ModuleAliasName, name: UnitName) -> Self

Create a unit reference qualified by a module alias (u.mile).

pub const fn qualifier(&self) -> Option<&ModuleAliasName>

The module alias qualifying this reference, if any.

pub const fn name(&self) -> &UnitName

The unit leaf name.

pub const fn is_qualified(&self) -> bool

Returns whether this reference is module-qualified.

Trait Implementations

impl Clone for UnitRef

fn clone(&self) -> UnitRef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UnitRef

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

Formats the value using the given formatter.

impl Display for UnitRef

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

Formats the value using the given formatter.

impl Eq for UnitRef

impl FormatEquivalent for UnitRef

fn format_equivalent(&self, other: &Self) -> bool

Returns true if self and other are equivalent up to formatting.

impl From<NameAtom> for UnitRef

fn from(atom: NameAtom) -> Self

Wrap a bare atom as a local unit reference. This is what crate::syntax::ast::Ident::into_spanned uses to lift parser identifiers into the typed reference.

impl From<NameDef<Unit>> for UnitRef

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.

impl Hash for UnitRef

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 UnitRef

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

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

fn partial_cmp(&self, other: &UnitRef) -> 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 StructuralPartialEq for UnitRef