Struct Config 

pub struct Config {
    pub fallback_options: FallbackOptions,
    /* private fields */
}

Encapsulates the shell’s programmable command completion configuration.

Fields

fallback_options: FallbackOptions

Fallback options to use when ‘default’ completions are requested (not to be confused with the ‘default’ completion spec, nor ‘bashdefault’ completions).

Implementations

impl Config

pub fn clear(&mut self)

Removes all registered completion specs.

pub fn remove(&mut self, name: SpecName<'_>) -> 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 = (SpecName<'_>, &Spec)>

Returns an iterator over the completion specs and their names, in no particular order.

pub fn get(&self, name: SpecName<'_>) -> Option<&Spec>

If present, returns the named completion spec.

Arguments

• name - The name of the completion spec.

pub fn get_mut(&mut self, name: SpecName<'_>) -> Option<&mut Spec>

If present, returns a mutable reference to the named completion spec.

Arguments

• name - The name of the completion spec.

pub fn set(&mut self, name: SpecName<'_>, spec: Spec)

Registers the provided completion spec under the given name, replacing any already registered there.

Arguments

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

Trait Implementations

impl Clone for Config

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for Config

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Config

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 Config

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.