Struct PackageName 

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

A package name: one flat identifier, ASCII lowercase letters, digits and hyphens, starting with a letter, with every hyphen followed by a letter — docs/spec/packages.md’s whole rule for name. That shape is what keeps a package name and a module name from ever being confused (one is lowercase-with-hyphens, the other uppercase-with-dots), and what makes the namespace a package’s name derives unambiguous.

The only way to build one is PackageName::new, which rejects anything that does not match the rule — there is no way to hold a PackageName that manifest validation would have refused.

Implementations

impl PackageName

pub fn new<S: Into<String>>(name: S) -> Result<PackageName, InvalidPackageName>

Build a PackageName, or say why name is not one.

pub fn as_str(&self) -> &str

pub fn core() -> PackageName

zelkova-core, resolve::CORE_PACKAGE: the one package the compiler names on its own, because it is where the scalars are declared.

Built without going through PackageName::new’s check, so that naming a scalar needs no unwrap; that the constant passes the check is a unit test.

pub fn is_core(&self) -> bool

Whether this is zelkova-core, the one package the default imports and the scalar seeding they are replaced by both key themselves on (DEC-17 decision 4) — and, since resolve::visible_modules rejects any other package that declares one of the eight, the only package that can be shaped like it.

pub fn namespace(&self) -> Name

The prefix this package’s modules are named through from outside it: the name split at its hyphens, each piece capitalised, joined — The namespace. acme-widgets is AcmeWidgets, todo is Todo.

It is a Name and not a PackageName: what comes back is a module-name prefix, and the whole point of the shape rule above is that the two are never confusable. Distinct package names give distinct namespaces, which is what lets two wrapped dependencies keep out of each other’s way with nothing checked.

A package never writes its own namespace, so nothing inside the package being compiled goes through here: resolve::visible_modules is the one caller, and it applies this only to a dependency’s modules.

Trait Implementations

impl Clone for PackageName

fn clone(&self) -> PackageName

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PackageName

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

Formats the value using the given formatter.

impl Display for PackageName

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

Formats the value using the given formatter.

impl Eq for PackageName

impl Hash for PackageName

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 PartialEq for PackageName

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for PackageName