Struct clap_complete::ArgValueCompleter

pub struct ArgValueCompleter(/* private fields */);

Available on crate feature unstable-dynamic only.

Extend Arg with a CustomCompleter

Example

use clap::Parser;
use clap_complete::dynamic::{ArgValueCompleter, CompletionCandidate};

#[derive(Debug, Parser)]
struct Cli {
    #[arg(long, add = ArgValueCompleter::new(|| { vec![
        CompletionCandidate::new("foo"),
        CompletionCandidate::new("bar"),
        CompletionCandidate::new("baz")] }))]
    custom: Option<String>,
}

Implementations

impl ArgValueCompleter

pub fn new<C>(completer: C) -> Self

where C: CustomCompleter + 'static,

Create a new ArgValueCompleter with a custom completer

pub fn candidates(&self) -> Vec<CompletionCandidate>

All potential candidates for an argument.

See CompletionCandidate for more information.

Trait Implementations

impl Clone for ArgValueCompleter

fn clone(&self) -> ArgValueCompleter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ArgValueCompleter

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

Formats the value using the given formatter.

impl ArgExt for ArgValueCompleter