Struct State 

pub struct State<Id> { /* private fields */ }

Available on crate feature command-palette only.

Whether the palette is open, its pages, the recent commands and the command list on show.

Implementations

impl<Id: Clone + PartialEq> State<Id>

pub fn new(groups: impl IntoIterator<Item = Group<Id>>) -> Self

A closed palette listing groups on its first page.

pub fn with_page(self, page: Page<Id>) -> Self

Adds a nested page. Choosing the item with the page’s id opens it.

pub fn with_recent(self, ids: impl IntoIterator<Item = Id>) -> Self

Starts with these recent commands, newest first.

pub fn with_recent_limit(self, limit: usize) -> Self

How many recent commands to keep. Zero turns the recent group off.

pub fn with_visible_rows(self, rows: usize) -> Self

How many rows show at once. At least one does.

pub fn is_open(&self) -> bool

pub fn page(&self) -> Option<&Page<Id>>

The nested page on show, or None on the first page.

pub fn page_id(&self) -> Option<&Id>

The id of the nested page on show.

pub fn depth(&self) -> usize

How many nested pages are open.

pub fn recent(&self) -> &[Id]

Recent commands, newest first.

pub fn command(&self) -> &State<Id>

The command list on show, with its query, results and highlight.

pub fn query(&self) -> &str

pub fn set_groups(&mut self, groups: impl IntoIterator<Item = Group<Id>>)

Replaces the first page’s groups, such as when a label changes.

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

Applies an event and returns what the app may need to act on.

pub fn key_event( &self, keymap: &Keymap<Action>, key: &Event, ) -> Option<Event<Id>>

Turns a key press into an event: a toggle chord at any time, and Back only while a nested page is open with an empty query, so Backspace still deletes text.

Trait Implementations

impl<Id: Clone> Clone for State<Id>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Id: Debug> Debug for State<Id>

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

Formats the value using the given formatter.

impl<Id: PartialEq> PartialEq for State<Id>

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

Equality operator ==.

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

Inequality operator !=.

impl<Id: PartialEq> StructuralPartialEq for State<Id>