Struct fm::completion::Completion

pub struct Completion {
    pub kind: InputCompleted,
    pub proposals: Vec<String>,
    pub index: usize,
}

Holds a Vec<String> of possible completions and an usize index showing where the user is in the vec.

Fields

kind: InputCompleted

proposals: Vec<String>

Possible completions

index: usize

Which completion is selected by the user

Implementations

impl Completion

pub fn set_kind(&mut self, mode: &Mode)

pub fn is_empty(&self) -> bool

Is there any completion option ?

pub fn next(&mut self)

Move the index to next element, cycling to 0. Does nothing if the list is empty.

pub fn prev(&mut self)

Move the index to previous element, cycling to the last one. Does nothing if the list is empty.

pub fn current_proposition(&self) -> &str

Returns the currently selected proposition. Returns an empty string if proposals is empty.

pub fn reset(&mut self)

Empty the proposals Vec. Reset the index.

pub fn complete(
    &mut self,
    input_string: &str,
    path_content: &PathContent,
    current_path: &str
) -> FmResult<()>

Fill the completions items from some parameters, depending on the mode. In Exec mode, we search for executable in $PATH starting with what the user typed. In Goto mode, we search for valid absolute & relative paths starting with what the user typed. In Search mode, we search for filenames in current directory starting with what the user typed.

Trait Implementations

impl Clone for Completion

fn clone(&self) -> Completion

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Completion

fn default() -> Completion

Returns the “default value” for a type.