Enum bpaf::ShellComp

#[non_exhaustive]
pub enum ShellComp {
    File {
        mask: Option<&'static str>,
    },
    Dir {
        mask: Option<&'static str>,
    },
    Raw {
        bash: &'static str,
        zsh: &'static str,
        fish: &'static str,
        elvish: &'static str,
    },
    Nothing,
}

Available on crate feature autocomplete only.

Shell specific completion

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

File

Fields

mask: Option<&'static str>

Optional filemask to use, no spaces, no tabs

A file or directory name with an optional file mask.

For bash filemask should start with *. or contain only the extension

Dir

Fields

mask: Option<&'static str>

Optional filemask to use, no spaces, no tabs

Similar to File but limited to directories only For bash filemask should start with *. or contain only the extension

Raw

Fields

bash: &'static str

This raw string will be used for bash shell https://www.gnu.org/software/bash/manual/html_node/Command-Line-Editing.html

zsh: &'static str

This raw string will be used for zsh shell https://zsh.sourceforge.io/Doc/Release/Completion-System.html

fish: &'static str

This raw string will be used for fish shell https://fishshell.com/docs/current/completions.html

elvish: &'static str

This raw string will be used for elvish shell https://elv.sh/ref/edit.html#completion-api

You can also specify a raw value to use for each supported shell

It is possible to fill in values for shells you don’t want to support with empty strings but the code is not going to work for those shells

Nothing

Don’t produce anything at all from this parser - can be useful if you want to compose bpaf completion with shell completion

Trait Implementations

impl Clone for ShellComp

fn clone(&self) -> ShellComp

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ShellComp

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

Formats the value using the given formatter.

impl Copy for ShellComp