Struct WorkspaceId 

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

The name a workspace has on disk: lower-case ASCII letters and digits, separated by -.

Generated from a display name with from_display_name and read back from disk with parse. Every identifier is also a legal folder name, a legal container name and a legal volume name, so the same string names the workspace everywhere.

Implementations

impl WorkspaceId

pub const MAX_LEN: usize = 64

The longest an identifier may be, in characters.

The identifier is part of qcode-home-<workspace>-<profile>, of a folder name below the store and of a volume name; 64 leaves room for all of them inside the 255 characters the strictest of them allows.

pub fn from_display_name(name: &str) -> Result<Self, WorkspaceIdError>

Builds the identifier of a workspace the user named name.

Letters fold to ASCII, everything else becomes a single -, and leading and trailing separators — which is where a trailing dot or space ends up — are removed. A name a device is called by is moved out of the way. The result never depends on the locale.

Errors

WorkspaceIdError::Empty when nothing in name can be part of an identifier.

pub fn parse(text: &str) -> Result<Self, WorkspaceIdError>

Reads an identifier that is already stored: a folder name, a key in the config or the id of a workspace.qcode.

Errors

Says which rule the text breaks, so the caller can point at it.

pub fn as_str(&self) -> &str

The identifier as it is written on disk.

pub fn clashes_with(&self, name: &str) -> bool

Whether a file system that ignores case would see name as this workspace’s folder.

Folding is ASCII only on purpose: an identifier holds nothing else, and a locale-aware fold would answer differently in a Turkish locale.

Trait Implementations

impl Clone for WorkspaceId

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 WorkspaceId

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

Formats the value using the given formatter.

impl Display for WorkspaceId

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

Formats the value using the given formatter.

impl Eq for WorkspaceId

impl Hash for WorkspaceId

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 WorkspaceId

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 WorkspaceId

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for WorkspaceId

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 WorkspaceId