Struct Spec 

pub struct Spec {
    pub options: GenerationOptions,
    pub actions: Vec<CompleteAction>,
    pub glob_pattern: Option<String>,
    pub word_list: Option<String>,
    pub function_name: Option<String>,
    pub command: Option<String>,
    pub filter_pattern: Option<String>,
    pub filter_pattern_excludes: bool,
    pub prefix: Option<String>,
    pub suffix: Option<String>,
}

Encapsulates a command completion specification; provides policy for how to generate completions for a given input.

Fields

options: GenerationOptions

Options to use for completion.

actions: Vec<CompleteAction>

Actions to take to generate completions.

glob_pattern: Option<String>

Optionally, a glob pattern whose expansion will be used as completions.

word_list: Option<String>

Optionally, a list of words to use as completions.

function_name: Option<String>

Optionally, the name of a shell function to invoke to generate completions.

command: Option<String>

Optionally, the name of a command to execute to generate completions.

filter_pattern: Option<String>

Optionally, a pattern to filter completions.

filter_pattern_excludes: bool

If true, completion candidates matching filter_pattern are removed; otherwise, those not matching it are removed.

prefix: Option<String>

Optionally, provides a prefix to be prepended to all completion candidates.

suffix: Option<String>

Optionally, provides a suffix to be prepended to all completion candidates.

Implementations

impl Spec

pub async fn get_completions( &self, shell: &mut Shell, context: &Context<'_>, ) -> Result<Answer, Error>

Generates completion candidates using this specification.

Arguments

• shell - The shell instance to use for completion generation.
• context - The context in which completion is being generated.

Trait Implementations

impl Clone for Spec

fn clone(&self) -> Spec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Spec

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

Formats the value using the given formatter.

impl Default for Spec

fn default() -> Spec

Returns the “default value” for a type.