Struct Name 

pub struct Name(/* private fields */);

new type over identifier names

This is a simple String representing an identifier name. In the future, we might want to introduce interning (either on Name or QualName). The inner String is private so that such a change stays local to this module; reach for Name::new, as_str, From<&str>, or Display instead of the field.

Names are ordered by their text, byte by byte. For UTF-8 that is the order of the code points, and a name that another begins with comes first: the label order a record type’s fields are kept in once canonicalized (docs/spec/records.md, Records and derivation).

Implementations

impl Name

pub fn new<S>(s: S) -> Name

where S: Into<String>,

Build a Name from any owned-or-borrowed string source.

pub fn as_str(&self) -> &str

Borrow the underlying identifier text.

pub fn qualify_with(self, s: String) -> Name

Qualify the existing name with a module: Size qualified with AcmeWidgets is AcmeWidgets.Size.

The result is a spelling — what a source file writes to reach a name through a module, an alias or a namespace — and not an identity, which is why it is a Name and not a zelkova_compiler::name::QualName: a spelling says nothing about which package declared what it reaches.

pub fn last_segment(&self) -> Name

The last dot-separated segment of this name: add of Js.Basics.add, and the whole name when it has no dot.

A qualified spelling names a declaration by its own name in its last segment, whatever module or alias the segments before it wrote.

pub fn starts_with(&self, other: &Name) -> bool

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

Formats the value using the given formatter.

impl Display for Name

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

Formats the value using the given formatter.

impl Eq for Name

impl From<&str> for Name

fn from(n: &str) -> Name

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,

Restrict a value to a certain interval.

impl PartialEq for Name

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

Equality operator ==.

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

Inequality operator !=.

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

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 Name