Struct SortingState 

pub struct SortingState { /* private fields */ }

Complete sorting state for the table.

Tracks all active column sorts and their configuration, supporting multi-column sorting with configurable limits.

Implementations

impl SortingState

pub fn new() -> SortingState

Creates a new empty sorting state.

Returns

• SortingState: A new empty sorting state with multi-sort and sort removal enabled.

pub fn with_sorts(sorts: Vec<SortState>) -> SortingState

Creates sorting state with initial sorts.

Parameters

• sorts: The initial list of sort states.

Returns

• SortingState: A new sorting state with the provided sorts.

pub fn with_max_multi_sort_columns(self, max: usize) -> SortingState

Sets the maximum number of multi-sort columns.

Parameters

• max: The maximum number of simultaneously sorted columns.

Returns

• Self: The modified sorting state.

pub fn with_multi_sort(self, enable: bool) -> SortingState

Enables or disables multi-sort.

Parameters

• enable: Whether multi-column sorting is enabled.

Returns

• Self: The modified sorting state.

pub fn with_sort_removal(self, enable: bool) -> SortingState

Enables or disables sort removal on toggle.

Parameters

• enable: Whether sorts are removed when toggling past descending.

Returns

• Self: The modified sorting state.

pub fn sorts(&self) -> &[SortState]

Returns the current sorts.

Returns

• &[SortState]: A slice of active sort states.

pub fn is_sorted(&self) -> bool

Returns whether any sorting is active.

Returns

• bool: Whether at least one column is sorted.

pub fn get_sort(&self, column_id: &ColumnId) -> Option<&SortState>

Returns the sort state for a specific column.

Parameters

• column_id: The column identifier to look up.

Returns

• Option<&SortState>: The sort state if the column is sorted.

pub fn get_sort_index(&self, column_id: &ColumnId) -> Option<usize>

Returns the sort index for a column (for multi-sort display).

Parameters

• column_id: The column identifier to look up.

Returns

• Option<usize>: The zero-based sort priority index.

pub fn get_direction(&self, column_id: &ColumnId) -> Option<SortDirection>

Returns the sort direction for a column.

Parameters

• column_id: The column identifier to look up.

Returns

• Option<SortDirection>: The sort direction if the column is sorted.

pub fn toggle_sort(&mut self, column_id: impl Into<ColumnId>, multi: bool)

Toggles sorting for a column.

If multi is true and multi-sort is enabled, adds to the sort list. Otherwise, replaces the current sort.

Parameters

• column_id: The column identifier to toggle sorting for.
• multi: Whether to add to multi-sort list (true) or replace (false).

pub fn set_sort( &mut self, column_id: impl Into<ColumnId>, direction: SortDirection, )

Sets the sort for a column directly.

Parameters

• column_id: The column identifier.
• direction: The sort direction to set.

pub fn clear_sort(&mut self, column_id: &ColumnId)

Clears the sort for a specific column.

Parameters

• column_id: The column identifier to clear sorting for.

pub fn clear_all(&mut self)

Clears all sorting.

pub fn reset(&mut self)

Resets to initial state.

Trait Implementations

impl Clone for SortingState

fn clone(&self) -> SortingState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SortingState

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

Formats the value using the given formatter.

impl Default for SortingState

fn default() -> SortingState

Returns the “default value” for a type.

impl PartialEq for SortingState

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for SortingState

impl StructuralPartialEq for SortingState