Struct State 

pub struct State<Row, Key> { /* private fields */ }

Available on crate feature data-table only.

The rows, the columns and how the reader is looking at them.

Implementations

impl<Row, Key: Clone + Eq + Hash> State<Row, Key>

pub fn new( columns: impl IntoIterator<Item = Column<Row>>, rows: impl IntoIterator<Item = Row>, key: fn(&Row) -> Key, ) -> Self

A table over rows, showing columns in order. key gives each row an identity that survives sorting and new rows, such as an id.

pub fn with_selection(self, selectable: bool) -> Self

Adds a checkbox to every row and a select-all box to the header.

pub fn with_page_sizes(self, sizes: impl IntoIterator<Item = usize>) -> Self

The sizes offered in the footer. The first is used to start with.

pub fn with_sort(self, column: ColumnId, direction: Direction) -> Self

pub fn with_hidden(self, columns: impl IntoIterator<Item = ColumnId>) -> Self

Starts with these columns hidden.

pub fn rows(&self) -> &[Row]

pub fn columns(&self) -> &[Column<Row>]

pub fn visible_columns(&self) -> Vec<&Column<Row>>

The columns on screen, in order.

pub fn column(&self, id: ColumnId) -> Option<&Column<Row>>

pub fn is_hidden(&self, id: ColumnId) -> bool

pub fn columns_menu(&self) -> &State<ColumnId>

The Columns menu, with a check for each hideable column.

pub fn key(&self, row: &Row) -> Key

pub fn row(&self, key: &Key) -> Option<&Row>

pub fn set_rows(&mut self, rows: impl IntoIterator<Item = Row>)

Replaces every row. The sort, filters and selection of rows that remain are kept.

pub fn push(&mut self, row: Row)

pub fn update_row(&mut self, key: &Key, change: impl FnOnce(&mut Row))

Changes the row with this key, if there is one.

pub fn retain(&mut self, keep: impl FnMut(&Row) -> bool)

Keeps only the rows for which keep returns true.

pub fn sort(&self) -> Option<(ColumnId, Direction)>

pub fn search(&self) -> &str

pub fn filter(&self, column: ColumnId) -> Option<&str>

The text a column is filtered to, if any.

pub fn is_filtered(&self) -> bool

Whether the search or any filter hides rows.

pub fn options(&self, column: ColumnId) -> &[String]

The distinct texts of a filterable column, to choose from.

pub fn filtered_len(&self) -> usize

How many rows pass the search and filters.

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn page(&self) -> usize

The current page, counting from zero.

pub fn page_size(&self) -> usize

pub fn page_sizes(&self) -> &[usize]

pub fn page_count(&self) -> usize

How many pages the filtered rows fill; at least one.

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

Positions of the current page’s rows among the filtered rows.

pub fn page_rows(&self) -> Vec<&Row>

The rows on the current page, in order.

pub fn page_keys(&self) -> Vec<Key>

The keys of the rows on the current page, in order.

pub fn showing(&self) -> String

“Showing 1-10 of 243”, for the footer.

pub fn is_selectable(&self) -> bool

pub fn is_selected(&self, key: &Key) -> bool

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

Every selected key, on any page, in row order.

pub fn page_check_state(&self) -> CheckState

The header checkbox: checked when every row on the page is selected, indeterminate when some are.

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

The row the keyboard acts on.

pub fn is_focused(&self) -> bool

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

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

Turns a key press into an event through keymap.

Trait Implementations

impl<Row: Clone, Key: Clone> Clone for State<Row, Key>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Row: Debug, Key: Debug> Debug for State<Row, Key>

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

Formats the value using the given formatter.