Struct PickerData 

pub struct PickerData<M = ()> {
    pub title: Option<String>,
    pub input: TextInputState<PickerInputProvider>,
    pub query_placeholder: String,
    pub source_entries: Vec<PickerEntry>,
    pub filtered_indices: Vec<usize>,
    pub selected_filtered_index: Option<usize>,
    pub empty_preview: String,
    pub scopes: Vec<PickerScope>,
    pub layout: PickerLayout,
    pub head: Option<PickerHead>,
    /* private fields */
}

A generic, scope-aware fuzzy picker.

M is an application-owned mode payload stored opaquely (see set_mode); the library never inspects it. Use PickerData<()> (the default) when you don’t need one.

Fields

title: Option<String>

input: TextInputState<PickerInputProvider>

query_placeholder: String

source_entries: Vec<PickerEntry>

filtered_indices: Vec<usize>

selected_filtered_index: Option<usize>

empty_preview: String

scopes: Vec<PickerScope>

layout: PickerLayout

head: Option<PickerHead>

Implementations

impl<M> PickerData<M>

pub fn new() -> Self

pub fn with_entries(entries: Vec<PickerEntry>) -> Self

pub fn with_layout(self, layout: PickerLayout) -> Self

pub fn single_pane(self) -> Self

pub fn set_layout(&mut self, layout: PickerLayout)

pub fn with_head(self, head: PickerHead) -> Self

pub fn set_head(&mut self, head: PickerHead)

pub fn clear_head(&mut self)

pub fn with_field_weights(self, weights: PickerFieldWeights) -> Self

pub fn set_field_weights(&mut self, weights: PickerFieldWeights)

pub fn field_weights(&self) -> &PickerFieldWeights

pub fn set_mode(&mut self, mode: M)

Attach an application-owned mode payload. The library stores it verbatim and never inspects it; read it back with mode_ref / mode_mut.

pub fn with_mode(self, mode: M) -> Self

pub fn clear_mode(&mut self)

pub fn take_mode(&mut self) -> Option<M>

pub fn mode_ref(&self) -> Option<&M>

pub fn mode_mut(&mut self) -> Option<&mut M>

pub fn set_entries(&mut self, entries: Vec<PickerEntry>)

pub fn set_scopes(&mut self, scopes: Vec<PickerScope>)

pub fn set_suggestion_scopes(&mut self, scopes: Option<Vec<PickerScope>>)

pub fn clear_suggestion_scopes(&mut self)

pub fn set_implicit_scope(&mut self, token: &str, value: &str)

pub fn set_selected_source_index(&mut self, source_index: Option<usize>)

pub fn push_char(&mut self, ch: char)

pub fn pop_char(&mut self)

pub fn clear_input(&mut self)

pub fn input_ref(&self) -> &TextInputState<PickerInputProvider>

pub fn input_mut(&mut self) -> &mut TextInputState<PickerInputProvider>

pub fn refresh_filter(&mut self)

pub fn move_up(&mut self)

pub fn move_down(&mut self)

pub fn filtered_len(&self) -> usize

pub fn visible_entries(&self) -> impl Iterator<Item = (usize, &PickerEntry)>

pub fn selected_entry(&self) -> Option<&PickerEntry>

pub fn count_label(&self) -> String

pub fn scope_hint(&self) -> String

pub fn active_scope_label(&self) -> Option<String>

pub fn paste(&mut self, text: &str) -> TextInputEventOutcome

pub fn autocomplete_selected(&mut self) -> TextInputEventOutcome

Trait Implementations

impl<M: Clone> Clone for PickerData<M>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<M: Debug> Debug for PickerData<M>

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

Formats the value using the given formatter.

impl<M> Default for PickerData<M>

fn default() -> Self

Returns the “default value” for a type.

impl<M: Eq> Eq for PickerData<M>

impl<M: PartialEq> PartialEq for PickerData<M>

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.