Enum CompletionFormat 

pub enum CompletionFormat {
    Simple,
    Display,
    Zsh,
    Fish,
    Bash,
}

Represents the format in which completions should be returned

Variants

Simple

Simple list of values (for basic shells)

Display

Values with descriptions for display (not for shell consumption)

Zsh

Zsh format with descriptions

Fish

Fish format with descriptions

Bash

Bash format (requires special handling)

Implementations

impl CompletionFormat

pub fn from_shell_type(shell_type: Option<&str>) -> Self

Detects the format from the shell type string

pub fn format( self, result: &CompletionResult, ctx: Option<&Context>, ) -> Vec<String>

Formats a completion result according to this format

Trait Implementations

impl Clone for CompletionFormat

fn clone(&self) -> CompletionFormat

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CompletionFormat

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

Formats the value using the given formatter.

impl Copy for CompletionFormat