Struct Picker 

pub struct Picker<T> { /* private fields */ }

State of the picker itself.

Implementations

impl<T> Picker<T>

pub fn load(&mut self, configuration: &BTreeMap<String, String>)

This function must be called during your plugin’s load function.

pub fn update(&mut self, event: &Event) -> Option<Response>

This function must be called during your plugin’s update function. If an entry was selected or the picker was closed, this function will return a Response. This function will update the picker’s internal state of whether it needs to redraw the picker, so your plugin’s update function should return true if needs_redraw returns true.

pub fn render(&mut self, rows: usize, cols: usize)

This function must be called during your plugin’s render function.

pub fn needs_redraw(&self) -> bool

Returns true if the picker needs to be redrawn. Your plugin’s update function should return true if this function returns true.

pub fn entries(&self) -> &[Entry<T>]

Returns the current list of entries in the picker.

pub fn select(&mut self, idx: usize)

Forces a specific entry in the list of entries to be selected.

pub fn clear(&mut self)

Removes all entries in the list.

pub fn extend(&mut self, iter: impl IntoIterator<Item = Entry<T>>)

Adds new entries to the list.

pub fn use_case_matching_respect(&mut self)

Request that the fuzzy matcher always respect case when matching.

pub fn use_case_matching_ignore(&mut self)

Request that the fuzzy matcher always ignore case when matching.

pub fn use_case_matching_smart(&mut self)

Request that the fuzzy matcher respect case when matching if the query contains any uppercase characters, but ignore case otherwise. This is the default.

pub fn enter_search_mode(&mut self)

Puts the picker into search mode (equivalent to pressing / when in normal mode).

pub fn enter_normal_mode(&mut self)

Puts the picker into normal mode (equivalent to pressing Escape when in search mode). This is the default.

pub fn set_match_paths(&mut self)

Configures the fuzzy matcher to adjust matching bonuses appropriate for matching paths.

pub fn clear_match_paths(&mut self)

Configures the fuzzy matcher to adjust matching bonuses appropriate for matching arbitrary strings. This is the default.

Trait Implementations

impl<T: Default> Default for Picker<T>

fn default() -> Picker<T>

Returns the “default value” for a type.