Struct SafeName 

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

A name that is safe everywhere QCode puts it: as a file name in the store, as part of an image name, and as a container or volume name.

It holds lowercase ASCII letters, digits and single hyphens, and begins and ends with a letter or digit. Folding is written out character by character rather than left to str::to_lowercase, so that the same text gives the same name on every machine: in Turkish I and İ do not fold the way the rest of the world folds them, and a name is a file name.

Implementations

impl SafeName

pub const MAX_LENGTH: usize = 64

The longest a name may be, in characters. Container engines take far longer names; the limit keeps a name readable in a list and leaves room for the prefixes QCode adds.

pub fn from_display(text: &str) -> Option<Self>

Makes a name out of text a person typed, such as a workspace title. Letters fold to ASCII, everything else becomes a single hyphen, and the result is cut to Self::MAX_LENGTH. Text without a single usable character has no name.

pub fn parse(text: &str) -> Option<Self>

Reads a name that is already safe, such as one from a definition file. Text that is not exactly what Self::from_display would have produced is refused rather than repaired, so that a file and the name in it can never disagree.

pub fn as_str(&self) -> &str

The name as text.

Trait Implementations

impl Clone for SafeName

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SafeName

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

Formats the value using the given formatter.

impl Display for SafeName

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

Formats the value using the given formatter.

impl Eq for SafeName

impl Hash for SafeName

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 SafeName

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

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for SafeName

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for SafeName

fn partial_cmp(&self, other: &Self) -> 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 SafeName