Struct SortModal 

pub struct SortModal {
    pub filter_input: TextInput,
    pub columns: Vec<SortColumn>,
    pub table_state: TableState,
    pub has_unapplied_changes: bool,
    pub history_limit: usize,
    pub status: Option<String>,
    pub applied_order: Vec<String>,
    pub applied_locked: usize,
    pub page_rows: usize,
    /* private fields */
}

Fields

filter_input: TextInput

columns: Vec<SortColumn>

table_state: TableState

has_unapplied_changes: bool

history_limit: usize

status: Option<String>

Why the last key did nothing, for the sidebar’s status line; the next key clears it.

applied_order: Vec<String>

The column order last applied, hidden columns included. The table keeps only the visible order, so this is where a hidden column is listed, and returns to, when the sidebar reopens.

applied_locked: usize

How many leading columns of applied_order were frozen, hidden ones included: the table’s count leaves out a hidden column that ended the span.

page_rows: usize

Rows the Columns list showed when last drawn: what PgUp and PgDn move.

Implementations

impl SortModal

pub fn filtered_columns(&self) -> Vec<(usize, &SortColumn)>

The columns the find text matches, in display order. Asked several times a key, so recomputed only when a fingerprint of the find text, names and order changes.

pub fn get_column_order(&self) -> Vec<String>

pub fn get_locked_columns_count(&self) -> usize

How many visible columns the table freezes: those at or before the last locked column in the order. A hidden column inside that span keeps its place but is not counted, since the table never draws it.

pub fn get_locked_span(&self) -> usize

How many leading columns of the full order are frozen, hidden ones included.

pub fn get_full_column_order(&self) -> Vec<String>

Every column of the order: all columns, hidden included, sorted by place.

pub fn get_sorted_columns(&self) -> Vec<String>

pub fn sorted_columns_and_directions(&self) -> (Vec<String>, Vec<bool>)

The staged sort: column names in sort order, and per column whether it runs descending.

pub fn cycle_sort(&mut self)

Space on a column: none → ascending → descending → none. Joining the sort appends the column at the end; leaving it renumbers the rest.

pub fn cycle_sort_back(&mut self)

← on a column: the cycle of Space backwards, none → descending → ascending → none.

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

The sort, as indices into columns, first key first.

pub fn flip_sort(&mut self, entry: usize)

Flip the direction of the sort’s entryth key.

pub fn remove_sort_entry(&mut self, entry: usize)

Drop the sort’s entryth key; the keys after it move up.

pub fn move_sort_entry(&mut self, entry: usize, earlier: bool) -> usize

Move the sort’s entryth key one place earlier or later. Returns where it is now.

pub fn add_sort(&mut self, name: &str) -> Option<usize>

Add the column named name as the sort’s last key, ascending. Returns its place in the sort; None when no column has that name. A column already sorted keeps its place.

pub fn remove_sort(&mut self)

Del on a column: drop it from the sort outright, wherever in the cycle it stands, and renumber the columns after it.

pub fn move_column_display_up(&mut self)

pub fn move_column_display_down(&mut self)

pub fn toggle_lock_at_column(&mut self)

pub fn move_selection_up(&mut self)

pub fn move_selection_down(&mut self)

pub fn clear_selection(&mut self)

pub fn change_width( &mut self, change: impl FnOnce(WidthChoice, Option<u16>) -> WidthChoice, )

Change how the width of the column under the cursor is chosen, from what is staged: < and > step it, f fits it to the rows on screen, w returns it to automatic.

pub fn width_choices(&self) -> Vec<(String, WidthChoice)>

Every column’s width choice, as staged, for the table to apply.

pub fn toggle_visibility(&mut self)

Hide or show the column under the cursor. Visibility only: the column keeps its place in the order and its lock, so showing it puts it back where it was.

pub fn jump_selection_to_order(&mut self, new_order: usize)

Trait Implementations

impl Default for SortModal

fn default() -> Self

Returns the “default value” for a type.