Struct SchemaValueParser 

pub struct SchemaValueParser<T>
where
    T: Clone + Send + Sync + 'static,
{ /* private fields */ }

A clap [TypedValueParser] that uses schemars::JsonSchema to surface enum variants as possible values, and std::str::FromStr for actual parsing.

When T is an enum deriving JsonSchema, its variants appear in --help output and clap’s error messages with no extra derives on the user type. For non-enum types (e.g. String, u32), this is a transparent pass-through to FromStr.

Used automatically by #[cli]-generated code when both the cli and jsonschema features are enabled.

Implementations

impl<T> SchemaValueParser<T>

where T: JsonSchema + FromStr + Clone + Send + Sync + 'static,

pub fn new() -> SchemaValueParser<T>

Trait Implementations

impl<T> Clone for SchemaValueParser<T>

where T: Clone + Send + Sync + 'static,

fn clone(&self) -> SchemaValueParser<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Default for SchemaValueParser<T>

where T: JsonSchema + FromStr + Clone + Send + Sync + 'static,

Available on crate features cli and jsonschema only.

fn default() -> SchemaValueParser<T>

Returns the “default value” for a type.

impl<T> TypedValueParser for SchemaValueParser<T>

where T: JsonSchema + FromStr + Clone + Send + Sync + 'static,

Available on crate features cli and jsonschema only.

type Value = T

Argument’s value type

fn parse_ref( &self, _cmd: &Command, _arg: Option<&Arg>, value: &OsStr, ) -> Result<T, Error>

Parse the argument value

fn possible_values( &self, ) -> Option<Box<dyn Iterator<Item = PossibleValue> + '_>>

Reflect on enumerated value properties

fn parse_ref_( &self, cmd: &Command, arg: Option<&Arg>, value: &OsStr, _source: ValueSource, ) -> Result<Self::Value, Error>

Parse the argument value

fn parse( &self, cmd: &Command, arg: Option<&Arg>, value: OsString, ) -> Result<Self::Value, Error>

Parse the argument value

fn parse_( &self, cmd: &Command, arg: Option<&Arg>, value: OsString, _source: ValueSource, ) -> Result<Self::Value, Error>

Parse the argument value

fn map<T, F>(self, func: F) -> MapValueParser<Self, F>

where T: Send + Sync + Clone, F: Fn(Self::Value) -> T + Clone,

Adapt a TypedValueParser from one value to another

fn try_map<T, E, F>(self, func: F) -> TryMapValueParser<Self, F>

where F: Fn(Self::Value) -> Result<T, E> + Clone + Send + Sync + 'static, T: Send + Sync + Clone, E: Into<Box<dyn Error + Send + Sync>>,

Adapt a TypedValueParser from one value to another