Struct Config 

pub struct Config {
    pub default: Option<Spec>,
    pub empty_line: Option<Spec>,
    pub initial_word: Option<Spec>,
    pub current_completion_options: Option<GenerationOptions>,
    /* private fields */
}

Encapsulates the shell’s programmable command completion configuration.

Fields

default: Option<Spec>

Optionally, a completion spec to be used as a default, when earlier matches yield no candidates.

empty_line: Option<Spec>

Optionally, a completion spec to be used when the command line is empty.

initial_word: Option<Spec>

Optionally, a completion spec to be used for the initial word of a command line.

current_completion_options: Option<GenerationOptions>

Optionally, stores the current completion options in effect. May be mutated while a completion generation is in-flight.

Implementations

impl Config

pub fn clear(&mut self)

Removes all registered completion specs.

pub fn remove(&mut self, name: &str) -> bool

Ensures the named completion spec is no longer registered; returns whether a removal operation was required.

Arguments

• name - The name of the completion spec to remove.

pub fn iter(&self) -> impl Iterator<Item = (&String, &Spec)>

Returns an iterator over the completion specs.

pub fn get(&self, name: &str) -> Option<&Spec>

If present, returns the completion spec for the command of the given name.

Arguments

• name - The name of the command.

pub fn set(&mut self, name: &str, spec: Spec)

If present, sets the provided completion spec to be associated with the command of the given name.

Arguments

• name - The name of the command.
• spec - The completion spec to associate with the command.

pub fn get_or_add_mut(&mut self, name: &str) -> &mut Spec

Returns a mutable reference to the completion spec for the command of the given name; if the command already was associated with a spec, returns a reference to that existing spec. Otherwise registers a new default spec and returns a mutable reference to it.

Arguments

• name - The name of the command.

pub async fn get_completions( &self, shell: &mut Shell, input: &str, position: usize, ) -> Result<Completions, Error>

Generates completions for the given input line and cursor position.

Arguments

• shell - The shell instance to use for completion generation.
• input - The input line for which completions are being generated.
• position - The 0-based index of the cursor in the input line.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for Config

fn default() -> Config

Returns the “default value” for a type.