Struct ArgValueCompleter

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

Available on crate feature unstable-dynamic only.

Extend Arg with a completer

Example

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

fn custom_completer(current: &std::ffi::OsStr) -> Vec<CompletionCandidate> {
    let mut completions = vec![];
    let Some(current) = current.to_str() else {
        return completions;
    };

    if "foo".starts_with(current) {
        completions.push(CompletionCandidate::new("foo"));
    }
    if "bar".starts_with(current) {
        completions.push(CompletionCandidate::new("bar"));
    }
    if "baz".starts_with(current) {
        completions.push(CompletionCandidate::new("baz"));
    }
    completions
}

#[derive(Debug, Parser)]
struct Cli {
    #[arg(long, add = ArgValueCompleter::new(custom_completer))]
    custom: Option<String>,
}

Implementations

impl ArgValueCompleter

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

where C: ValueCompleter + 'static,

Create a new ArgValueCompleter with a custom completer

pub fn complete(&self, current: &OsStr) -> Vec<CompletionCandidate>

Candidates that match current

See CompletionCandidate for more information.

Trait Implementations

impl Clone for ArgValueCompleter

fn clone(&self) -> ArgValueCompleter

Returns a duplicate 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