Enum Scalar 

pub enum Scalar {
    Text(Text),
    Integer(Bounds<i64>),
    Number(Bounds<f64>),
    Boolean,
    Choice(Vec<String>),
}

What one flag accepts, as the document describes it.

Eq is absent on purpose: a number’s bounds are f64, which has none.

Variants

Text(Text)

type: string, with whatever the document states about it.

Integer(Bounds<i64>)

type: integer, with whatever the document states about it.

Number(Bounds<f64>)

type: number, with whatever the document states about it.

Boolean

type: boolean.

Choice(Vec<String>)

enum: [..] on a string schema. These values complete.

Implementations

impl Scalar

pub fn parse(&self, raw: &str) -> Result<Value, ScalarError>

Turn one raw argument into the JSON value the wire wants, or refuse it the way the document does.

pub fn runnable(&self) -> Result<(), ScalarError>

Whether every rule this carries can be run at all.

A pattern the engine cannot read is the only rule that can fail this way, and it fails on every value — so a document is held to this while it is reduced, and the failure names the operation rather than turning up at a user’s flag.

pub fn value_name(&self) -> &'static str

The <NAME> shown for the flag’s value, and the closest thing the document gives an agent to a type.

pub fn note(&self) -> Option<String>

Everything the document constrains about this value, for the flag’s help line. Every note is a rule Scalar::parse enforces, in the document’s own numbers — help and refusal cannot come apart, because one rendering serves both.

Trait Implementations

impl Clone for Scalar

fn clone(&self) -> Scalar

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Scalar

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Scalar

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Scalar

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Scalar

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 Scalar