Struct PathCompleter 

pub struct PathCompleter { /* private fields */ }

Available on crate feature unstable-dynamic only.

Complete a value as a std::path::Path

Example

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

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

Implementations

impl PathCompleter

pub fn any() -> Self

Any path is allowed

pub fn file() -> Self

Complete only files

pub fn dir() -> Self

Complete only directories

pub fn stdio(self) -> Self

Include stdio (-)

pub fn filter( self, filter: impl Fn(&Path) -> bool + Send + Sync + 'static, ) -> Self

Select which paths should be completed

pub fn current_dir(self, path: impl Into<PathBuf>) -> Self

Override std::env::current_dir

Trait Implementations

impl Default for PathCompleter

fn default() -> Self

Returns the “default value” for a type.

impl ValueCompleter for PathCompleter

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

All potential candidates for an argument.

fn complete_at( &self, arg_index: usize, current: &OsStr, ) -> Vec<CompletionCandidate>

All potential candidates for the value at arg_index within the current occurrence.