Struct GroupingState 

pub struct GroupingState { /* private fields */ }

Complete grouping state for the table.

Tracks which columns are used for grouping and provides configuration for aggregation and expansion behavior.

Implementations

impl GroupingState

pub fn new() -> GroupingState

Creates a new empty grouping state.

Returns

• GroupingState: A new grouping state with no groups configured.

pub fn with_columns(columns: Vec<ColumnId>) -> GroupingState

Creates a grouping state with the given columns.

Parameters

• columns: The column identifiers to group by.

Returns

• GroupingState: A new grouping state with the specified columns.

pub fn with_enabled(self, enabled: bool) -> GroupingState

Sets whether grouping is enabled.

Parameters

• enabled: Whether grouping is active.

Returns

• Self: The modified grouping state.

pub fn with_aggregation(self, show: bool) -> GroupingState

Sets whether to show aggregation.

Parameters

• show: Whether aggregated values should be displayed.

Returns

• Self: The modified grouping state.

pub fn with_expand_by_default(self, expand: bool) -> GroupingState

Sets whether to expand groups by default.

Parameters

• expand: Whether groups start expanded.

Returns

• Self: The modified grouping state.

pub fn is_enabled(&self) -> bool

Returns whether grouping is enabled.

Returns

• bool: Whether grouping is enabled.

pub fn is_grouped(&self) -> bool

Returns whether any grouping is active.

Returns

• bool: Whether grouping is enabled and columns are configured.

pub fn group_by(&self) -> &[ColumnId]

Returns the group-by columns.

Returns

• &[ColumnId]: A slice of column identifiers used for grouping.

pub fn show_aggregation(&self) -> bool

Returns whether aggregation should be shown.

Returns

• bool: Whether aggregated values are displayed.

pub fn expand_by_default(&self) -> bool

Returns whether groups should expand by default.

Returns

• bool: Whether groups start in expanded state.

pub fn depth(&self) -> usize

Returns the grouping depth (number of group-by columns).

Returns

• usize: The number of grouping levels.

pub fn is_grouped_by(&self, column_id: &ColumnId) -> bool

Checks if a column is being grouped by.

Parameters

• column_id: The column identifier to check.

Returns

• bool: Whether the column is used for grouping.

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

Gets the group index for a column.

Parameters

• column_id: The column identifier to look up.

Returns

• Option<usize>: The zero-based group index if the column is grouped.

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

Adds a column to group by.

Parameters

• column_id: The column identifier to add.

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

Removes a column from grouping.

Parameters

• column_id: The column identifier to remove.

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

Toggles grouping for a column.

Parameters

• column_id: The column identifier to toggle.

pub fn set_group_by(&mut self, columns: Vec<ColumnId>)

Sets the group-by columns.

Parameters

• columns: The column identifiers to group by.

pub fn move_group(&mut self, column_id: &ColumnId, to_index: usize)

Moves a group column to a new index.

Parameters

• column_id: The column identifier to move.
• to_index: The target index.

pub fn clear(&mut self)

Clears all grouping.

pub fn reset(&mut self)

Resets to initial state.

Trait Implementations

impl Clone for GroupingState

fn clone(&self) -> GroupingState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GroupingState

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

Formats the value using the given formatter.

impl Default for GroupingState

fn default() -> GroupingState

Returns the “default value” for a type.

impl PartialEq for GroupingState

fn eq(&self, other: &GroupingState) -> 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 GroupingState

impl StructuralPartialEq for GroupingState