Struct Completion 

pub struct Completion {
    pub words: Vec<String>,
    pub word_index: usize,
    pub line: String,
    pub cursor_index: usize,
    pub completion_type: CompletionType,
    pub key: char,
}

A completion request. ref.

Fields

words: Vec<String>

An array of all the words in the command line, including the command itself. Corresponds to COMP_WORDS.

word_index: usize

The index of the word in words that is currently being completed. Corresponds to COMP_CWORD.

line: String

The current command line. Corresponds to COMP_LINE.

cursor_index: usize

The index of the current cursor position relative to the beginning of the current command. Corresponds to COMP_POINT.

completion_type: CompletionType

The type of completion attempted. Corresponds to COMP_TYPE.

key: char

The key (or final key of a key sequence) used to invoke the current completion function. Corresponds to COMP_KEY.

Implementations

impl Completion

pub fn init() -> Result<Option<Self>, CompletersError>

Construct a Completion object from command line arguments and envs. If COMPLETE environment variable:

• Is not set, or set to 0 or empty, return None.
• Is set to 1, return a Completion object.
• Is set to bash/nu/nushell, generate shell code and exit successfully.

Errors

If COMPLETE is set to any other value, return CompletersError::UnrecognizedEnvVar; If generate fails, return ShellCodeError.

pub fn from_args(args: Vec<String>) -> Result<Self, CompletersError>

Constructs a Completion object from the arguments, without the first argument (the program name).

Errors

Errors if provided args could not be parsed successfully.

pub fn complete<I>(candidates: I)

where I: IntoIterator, I::Item: Display,

Process the completion request and exit successfully.

pub fn delegate(self)

Delegate to the completion request and exit successfully.

pub fn empty()

Answer the completion request with no candidates.

pub fn generate_bash() -> Result<String, ShellCodeError>

Generate Bash completion code.

Errors

If the program name cannot be determined or is not a valid identifier in Bash, return ShellCodeError::Encoding. If IO error occurs, return ShellCodeError::IO.

pub fn generate_nu() -> Result<String, ShellCodeError>

Generate Nushell completion code.

Errors

Errors if failed to resolve name and path of current executable.

Trait Implementations

impl Clone for Completion

fn clone(&self) -> Completion

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Completion

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

Formats the value using the given formatter.