Struct fm::completion::Completion

pub struct Completion {
    pub proposals: Vec<String>,
    pub index: usize,
    /* private fields */
}

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

Fields

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 goto(&mut self, input_string: &str, current_path: &str) -> Result<()>

Goto completion. Looks for the valid path completing what the user typed.

pub fn exec(&mut self, input_string: &str) -> Result<()>

Looks for programs in $PATH completing the one typed by the user.

pub fn command(&mut self, input_string: &str) -> Result<()>

pub fn search_from_normal( &mut self, input_string: &str, path_content: &PathContent ) -> Result<()>

Looks for file within current folder completing what the user typed.

pub fn search_from_tree( &mut self, input_string: &str, content: &[(String, ColoredString)] ) -> Result<()>

Looks for file within tree completing what the user typed.

pub fn complete_input_string(&self, input_string: &str) -> Option<&str>

Complete the input string with current_proposition if possible. Returns the optional last chars of the current_proposition. If the current_proposition doesn’t start with input_string, it returns None.

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.