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 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 (complete -X), as given: candidates it matches are removed, or, if it starts with a ! (that doesn’t start an extglob pattern), those it doesn’t match.

prefix: Option<String>

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

suffix: Option<String>

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

Implementations

impl Spec

pub async fn generate( &self, shell: &mut Shell<impl ShellExtensions>, word: &str, ) -> Result<Vec<String>, Error>

Generates this spec’s completion candidates for word, a word on its own (not part of a line being completed), as the compgen builtin does: with any fallbacks its options ask for added, and like bash, in the order generated (sorting is for showing them to a user). A completion function or command run for word is told, like bash’s, about an empty line being completed for compgen.

This doesn’t start a completion in progress, so the compopt builtin can’t change the options applied to the candidates. Like bash, a completion function that asks for completion to restart generates no candidates.

Arguments

• shell - The shell instance to use for completion generation.
• word - The word to generate candidates for, as typed (with any quoting).

Errors

Returns an error if running the completion generator fails, for example when a completion function or command cannot be executed, or when globbing or word expansion fails.

Trait Implementations

impl Clone for Spec

fn clone(&self) -> Self

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() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Spec

Available on crate feature serde only.

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Spec

Available on crate feature serde only.

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.