Struct State 

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

Available on crate feature command only.

The groups, the query, the ranked results and the highlighted row.

Implementations

impl<Id> State<Id>

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

Lists every item and highlights the first enabled one. The highlight shows once the field has focus or the user moves it.

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

Sets how many rows show at once. At least one does.

pub fn query(&self) -> &str

pub fn groups(&self) -> &[Group<Id>]

pub fn results(&self) -> impl Iterator<Item = (&str, &Item<Id>)>

Every result in display order, with its group label.

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn highlighted(&self) -> Option<&Item<Id>>

The highlighted item, if any result is enabled.

pub fn highlighted_position(&self) -> Option<usize>

Position in State::results of the highlighted row.

pub fn shows_highlight(&self) -> bool

Whether the highlighted row is drawn highlighted: while the search field has focus, or once the user has moved the highlight. An idle inline list shows no highlight, though Enter still has a target.

pub fn is_focused(&self) -> bool

Whether the search field has focus.

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

where Id: Clone,

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

pub fn visible(&self) -> Range<usize>

Positions in State::results of the rows in view.

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>