Struct CommandName 

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

One half of a command name: kebab-cased, [a-z0-9-] only.

A command is two of these, <group> <command> — vouchers update. Which path segment each half is taken from is the grouping rule a bless step runs; this type is only what the user types.

A bless step writes both into its reduced model, so a name comes back off a blob as well as out of a document. Both doors are the same door: serde reads it as a String and runs it through CommandName::new, so a blob cannot smuggle in a name a document could not have produced.

Implementations

impl CommandName

pub fn new(origin: &'static str, raw: &str) -> Result<Self, NameError>

renderVoucher becomes render-voucher; anything that will not reduce to [a-z0-9-] is rejected rather than mangled.

origin is what the raw name was read off, and it is there for the error: a document whose own words cannot be spelled is told which word.

pub fn as_str(&self) -> &str

Trait Implementations

impl Clone for CommandName

fn clone(&self) -> CommandName

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CommandName

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CommandName

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for CommandName

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

Formats the value using the given formatter.

impl Eq for CommandName

impl From<CommandName> for String

fn from(name: CommandName) -> Self

Converts to this type from the input type.

impl Hash for CommandName

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 CommandName

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for CommandName

fn partial_cmp(&self, other: &CommandName) -> 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 Serialize for CommandName

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CommandName

impl TryFrom<String> for CommandName

type Error = NameError

The type returned in the event of a conversion error.

fn try_from(raw: String) -> Result<Self, NameError>

Performs the conversion.