Struct KrateName

pub struct KrateName<'name>(/* private fields */);

Used to wrap user-provided strings so that bad crate names are required to be handled separately from things more outside the user control such as I/O errors

Implementations

impl<'name> KrateName<'name>

pub fn crates_io(name: &'name str) -> Result<Self, Error>

Ensures the specified string is a valid crates.io crate name, according to the (current) crates.io name restrictions

1. Non-empty
2. May not start with a digit
3. Maximum of 64 characters in length
4. Must be ASCII alphanumeric, -, or _
5. May not be a reserved name
   • A Rust keyword
   • Name of a Cargo output artifact
   • Name of a std library crate (or test)
   • A reserved Windows name (such as nul)

pub fn cargo(name: &'name str) -> Result<Self, Error>

Ensures the specified string is a valid crate name according to cargo

1. Non-empty
2. May not start with a digit
3. Must be ASCII alphanumeric, -, or _
4. May not be a reserved name
   • A Rust keyword
   • Name of a Cargo output artifact
   • Name of a std library crate (or test)
   • A reserved Windows name (such as nul)

impl<'name> KrateName<'name>

pub fn prefix(&self, acc: &mut String, sep: char)

Writes the crate’s prefix to the specified string

Cargo uses a simple prefix in the registry index so that crate’s can be partitioned, particularly on disk without running up against potential OS specific issues when hundreds of thousands of files are located with a single directory

The separator should be std::path::MAIN_SEPARATOR in disk cases and ‘/’ when used for urls

pub fn relative_path(&self, sep: Option<char>) -> String

Gets the relative path to a crate

This will be of the form Self::prefix + <sep> + <name>

If not specified, the separator is std::path::MAIN_SEPARATOR

let crate_name: tame_index::KrateName = "tame-index".try_into().unwrap();
assert_eq!(crate_name.relative_path(Some('/')), "ta/me/tame-index");

Trait Implementations

impl<'name> Clone for KrateName<'name>

fn clone(&self) -> KrateName<'name>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'k> Debug for KrateName<'k>

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

Formats the value using the given formatter.

impl<'k> Display for KrateName<'k>

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

Formats the value using the given formatter.

impl<'name> TryFrom<&'name str> for KrateName<'name>

The simplest way to create a crate name, this just ensures that the crate name is non-empty, and ASCII alphanumeric, -, or, -, the minimum requirements for this crate

type Error = Error

The type returned in the event of a conversion error.

fn try_from(s: &'name str) -> Result<Self, Self::Error>

Performs the conversion.

impl<'name> Copy for KrateName<'name>