Struct cliparser::types::CliSpec

pub struct CliSpec {
    pub command: Vec<Command>,
    pub arguments: Vec<Argument>,
    pub positional_argument: Option<PositionalArgument>,
    pub meta_info: Option<CliSpecMetaInfo>,
}

Holds the command line spec (command/parameters/…)

Fields

command: Vec<Command>

A list of all possible commands and sub commands.

arguments: Vec<Argument>

A list of all possible command line arguments.

positional_argument: Option<PositionalArgument>

The name of the argument that will hold all arguments after the last known key based argument. If not defined, such positional arguments are not allowed.

meta_info: Option<CliSpecMetaInfo>

Meta information used for generating version and help messages

Implementations

impl CliSpec

pub fn new() -> CliSpec

Returns new instance

pub fn set_meta_info(self, meta_info: Option<CliSpecMetaInfo>) -> Self

Sets the spec meta info

pub fn add_command(self, command: &str) -> Self

Adds a command to the spec

pub fn add_subcommand(self, sub_command: Vec<&str>) -> Self

Adds a sub command to the spec

pub fn set_positional_argument(
    self,
    argument: Option<PositionalArgument>
) -> Self

Sets the PositionalArgument

pub fn add_argument(self, argument: Argument) -> Self

Adds a Argument

Trait Implementations

impl Clone for CliSpec

fn clone(&self) -> CliSpec

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CliSpec

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

Formats the value using the given formatter.

impl Default for CliSpec

fn default() -> CliSpec

Returns the “default value” for a type.

impl PartialEq<CliSpec> for CliSpec

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for CliSpec