Struct State 

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

Available on crate feature virtual-list only.

The items, the selection, the highlight and whether the list follows its end.

Implementations

impl<T> State<T>

pub fn new(items: impl IntoIterator<Item = T>) -> Self

A list in Mode::Single holding items.

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

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

Keeps at most limit items, dropping the oldest as new ones arrive. A limit of zero is treated as one.

pub fn with_follow(self, follow: bool) -> Self

Follows the end as items arrive, starting now. Scrolling away stops following, and scrolling back to the end or pressing End starts it again.

pub fn mode(&self) -> Mode

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn get(&self, index: usize) -> Option<&T>

pub fn iter(&self) -> impl Iterator<Item = &T>

The items, oldest first.

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

The most items kept, if there is a limit.

pub fn id(&self, index: usize) -> RowId

The id of the item at index.

pub fn index(&self, id: RowId) -> Option<usize>

The index of the item with id, if it is still in the list.

pub fn dropped(&self) -> u64

How many items have been dropped from the front so far.

pub fn is_selected(&self, index: usize) -> bool

pub fn selected(&self) -> Vec<usize>

Every selected index, in order.

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

The index the keyboard acts on.

pub fn is_focused(&self) -> bool

pub fn is_following(&self) -> bool

Whether the list is following its end.

pub fn page_size(&self) -> usize

How many rows the page keys move.

pub fn push(&mut self, item: T)

Appends an item, dropping the oldest when over the limit.

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

Appends items, dropping the oldest when over the limit.

pub fn set_items(&mut self, items: impl IntoIterator<Item = T>)

Replaces every item. The selection and highlight are cleared, and ids carry on from where the old items ended.

pub fn clear(&mut self)

Removes every item.

pub fn scroll_to(&mut self, index: usize)

Scrolls the item at index into view without highlighting it. A following list stops following unless it is the last item.

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

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<T>>

Turns a key press into an event through keymap.

Trait Implementations

impl<T: Clone> Clone for State<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for State<T>

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

Formats the value using the given formatter.

impl<T> Default for State<T>

fn default() -> Self

Returns the “default value” for a type.