Struct Complete

pub struct Complete {
    pub raw: Option<String>,
    pub position: Option<usize>,
    pub cmd: Vec<String>,
}

A clap-compatible struct that can be used to generate completions for the current CLI invocation.

Fields

raw: Option<String>

A single string corresponding to the raw CLI invocation.

e.g: $ my-command $((1 + 2)) b<TAB>ar baz would pass --raw "my-command $((1 + 2)) bar baz".

Note the significant whitespace!

May not always be available, depending on the shell.

position: Option<usize>

The cursor’s position within the raw CLI invocation.

e.g: $ my-command $((1 + 2)) b<TAB>ar baz would pass --position 25

May not always be available, depending on the shell.

cmd: Vec<String>

A list of strings corresponding to how the shell has interpreted the current command.

e.g: $ my-command foo $((1 + 2)) bar would pass -- my-command foo 3 bar.

Implementations

impl Complete

pub async fn println_to_stub_script<Cli: CommandFactory>( self, maybe_subcommand_of: Option<&str>, custom_completer_factory: impl CustomCompleterFactory, )

Generate completions for the given clap command, and prints them to stdout in the format the built-in stub scripts expect.

See Complete::generate_completions for more info.

pub async fn generate_completions<Cli: CommandFactory>( self, maybe_subcommand_of: Option<&str>, custom_completer_factory: impl CustomCompleterFactory, ) -> Vec<String>

Generate completions for the given clap command.

Set maybe_subcommand_of to the root command’s value if the binary may be invoked as subcommand. e.g: if the binary is invoked as cargo xtask, pass Some("cargo").

Trait Implementations

impl Args for Complete

fn group_id() -> Option<Id>

Report the [ArgGroup::id][crate::ArgGroup::id] for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate Self via [FromArgMatches::from_arg_matches_mut]

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate self via [FromArgMatches::update_from_arg_matches_mut]

impl CommandFactory for Complete

fn command<'b>() -> Command

Build a [Command] that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a [Command] that can update self.

impl FromArgMatches for Complete

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for Complete

fn parse() -> Self

Parse from std::env::args_os(), [exit][Error::exit] on error.

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, [exit][Error::exit] on error.

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, [exit][Error::exit] on error.

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.