Struct BashCompletionInput 

pub struct BashCompletionInput { /* private fields */ }

BashCompletionInput is a struct which contains input data passed from the shell into a completion script. Data within this struct should be used by a completion script to determine appropriate completion options.

Implementations

impl BashCompletionInput

pub fn from_env() -> Result<Self, BashCompletionInputParsingError>

Create a new BashCompletionInput by reading environment variables

pub fn new( line: &str, cursor_position: usize, ) -> Result<Self, BashCompletionInputParsingError>

Create a new BashCompletionInput manually, useful for testing

Trait Implementations

impl CompletionInput for BashCompletionInput

fn args(&self) -> Vec<&str>

fn arg_index(&self) -> usize

fn char_index(&self) -> usize

fn current_word(&self) -> &str

fn previous_word(&self) -> &str

fn complete_subcommand<'a, T>(&self, subcommands: T) -> Vec<String>

where T: IntoIterator<Item = &'a str>,

Given a list of subcommands, filter any that match the current word

fn complete_directory(&self) -> Vec<String>

Get directory completions based on the current word

fn complete_file(&self) -> Vec<String>

Get file completions based on the current word Also returns directories because the user may be entering a file within that directory

impl<T> From<T> for BashCompletionInput

where T: Into<String>,

Used only for unit testing

fn from(s: T) -> Self

Converts to this type from the input type.