Trait clap_builder::Args

pub trait Args: FromArgMatches + Sized {
    // Required methods
    fn augment_args(cmd: Command) -> Command;
    fn augment_args_for_update(cmd: Command) -> Command;

    // Provided method
    fn group_id() -> Option<Id> { ... }
}

Parse a set of arguments into a user-defined container.

Implementing this trait lets a parent container delegate argument parsing behavior to Self. with:

• #[command(flatten)] args: ChildArgs: Attribute can only be used with struct fields that impl Args.
• Variant(ChildArgs): No attribute is used with enum variants that impl Args.

NOTE: Deriving requires the derive feature flag

Required Methods

fn augment_args(cmd: Command) -> Command

Append to Command so it can instantiate Self.

See also CommandFactory.

fn augment_args_for_update(cmd: Command) -> Command

Append to Command so it can update self.

This is used to implement #[command(flatten)]

See also CommandFactory.

Provided Methods

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments

Object Safety

This trait is not object safe.

Implementations on Foreign Types

impl<T: Args> Args for Box<T>

fn augment_args(cmd: Command) -> Command

fn augment_args_for_update(cmd: Command) -> Command

Implementors