Struct Command

#[non_exhaustive]
pub struct Command { /* private fields */ }

A deserializable representation of a Clap command.

Example

use claptrap::Command;
let spec = r#"
    name = "myapp"
    version = "1.0.0"
    about = "An example application"
    [args]
    cfg = { short = 'c', long = "config", required = true }
 "#;
let cmd: Command = toml::from_str(spec)?;
let clap_cmd = clap::Command::from(cmd);
let matches = clap_cmd.try_get_matches_from(vec!["myapp", "--config", "config.toml"])?;
assert_eq!(matches.get_one::<String>("cfg"), Some(&"config.toml".to_string()));

See the Clap Command documentation.

Implementations

impl Command

pub fn get_name(&self) -> &str

pub fn get_subcommands(&self) -> impl Iterator<Item = &Self>

pub fn get_arguments(&self) -> impl Iterator<Item = &Arg>

Trait Implementations

impl Clone for Command

fn clone(&self) -> Command

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Command

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Command

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Command> for Command

fn from(cmd: Command) -> Self

Converts to this type from the input type.

impl JsonSchema for Command

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.