Struct Gate 

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

One named hazard an operation stands behind, spelled as a long flag.

--commit asks one question — did you mean to write? — and some operations are more than one question: an act that cannot be undone, and an act that reaches a third party, each want their own word rather than a second meaning for that one. A gate is answered beside the confirmation, never instead of it, so what a gate adds is always another thing to say and never permission to say less. What the word means is the adopter’s business and no business of this crate’s, which only carries it.

A gate travels in the 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 the spelling rule a command name passes, so a blob cannot smuggle in a flag a document could not have asked for.

Implementations

impl Gate

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

sendEmail becomes send-email; anything that will not reduce to [a-z0-9-] is rejected rather than mangled, because what is being spelled is a flag a user has to type.

pub fn as_str(&self) -> &str

The flag name, without the leading --.

Trait Implementations

impl Clone for Gate

fn clone(&self) -> Gate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Gate

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Gate

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Gate

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

Formats the value using the given formatter.

impl Eq for Gate

impl From<Gate> for String

fn from(gate: Gate) -> Self

Converts to this type from the input type.

impl Hash for Gate

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 Gate

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Gate

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

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 Gate

impl TryFrom<String> for Gate

type Error = NameError

The type returned in the event of a conversion error.

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

Performs the conversion.