Struct TableData 

pub struct TableData { /* private fields */ }

Rows of Values under Columns, optionally sorted, grouped and totalled, rendered as one core Table.

Sorting is stable and puts empty cells last (sort); the sorted columns get a ▲/▼ header indicator (^/v on an ASCII-only console). With a GroupBy, each group renders as a header row with the group’s key in the first column (prefixed by the grouped column’s header when that is not the first column), the group’s rows, and — when the grouping has aggregates — a summary row. totals adds a final summary over every row.

use rich::{Console, Justify};
use rich_ext::table::{Aggregate, Column, GroupBy, SortKey, TableData, Value};

let mut data = TableData::new([
    Column::new("team"),
    Column::new("service"),
    Column::new("pods").justify(Justify::Right),
]);
data.push(["core".into(), "api".into(), Value::Int(3)]);
data.push(["edge".into(), "web".into(), Value::Int(5)]);
data.push(["core".into(), "db".into(), Value::Int(1)]);
let data = data
    .sort_by([SortKey::asc(0), SortKey::asc(1)])
    .group_by(GroupBy::new(0).aggregate(Aggregate::sum(2)));

let out = Console::builder().width(40).build().render_export(&data);
assert_eq!(
    out,
    "\
┏━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━┓
┃ team ▲1  ┃ service ▲2 ┃ pods ┃
┡━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━┩
│ core     │            │      │
│ core     │ api        │    3 │
│ core     │ db         │    1 │
│ subtotal │            │    4 │
│ edge     │            │      │
│ edge     │ web        │    5 │
│ subtotal │            │    5 │
└──────────┴────────────┴──────┘
"
);

Implementations

impl TableData

pub fn title(self, title: impl Into<String>) -> Self

A centered title above the table (console markup, as the core Table::title).

pub fn caption(self, caption: impl Into<String>) -> Self

A centered caption below the table (console markup).

pub fn box_set(self, box_set: Box) -> Self

The box-drawing set (default HEAVY_HEAD, as the core table).

pub fn without_box(self) -> Self

Draw no borders and no column dividers.

pub fn show_edge(self, show: bool) -> Self

Draw the outer edges (default on).

pub fn expand(self, expand: bool) -> Self

Expand to the full available width.

pub fn border_style(self, style: Style) -> Self

Style the box border.

impl TableData

pub fn new(columns: impl IntoIterator<Item = Column>) -> Self

No rows under columns.

pub fn push(&mut self, row: impl IntoIterator<Item = Value>) -> &mut Self

Append a row. Missing cells are Null; extra cells are dropped.

pub fn extend<R: IntoIterator<Item = Value>>( &mut self, rows: impl IntoIterator<Item = R>, ) -> &mut Self

Append several rows.

pub fn sort_by(self, keys: impl IntoIterator<Item = SortKey>) -> Self

Sort by keys when rendering (the rows keep their stored order).

pub fn set_sort(&mut self, keys: impl IntoIterator<Item = SortKey>)

Replace the sort keys; an empty list keeps insertion order.

pub fn group_by(self, group: GroupBy) -> Self

Group the (sorted) rows.

pub fn totals( self, label: impl Into<String>, aggregates: impl IntoIterator<Item = Aggregate>, ) -> Self

Add a final summary row over every row. label fills the first cell, followed by the first column’s own aggregate if it has one (total: 6); an empty label leaves the aggregate alone.

pub fn style_rules(self, rules: StyleRules) -> Self

Style cells, rows and columns by value (rules). Rules restyle the rows; group headers and summary rows keep their own styles.

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

The columns.

pub fn rows(&self) -> &[Vec<Value>]

The rows, in the order they were added.

pub fn sort_keys(&self) -> &[SortKey]

The sort keys.

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

Row indices in display order (stable sort by the keys).

pub fn to_table(&self, console: &Console) -> Table

The core table: headers with sort indicators, then the sorted rows, grouped and totalled as configured.

Trait Implementations

impl AccessibleText for TableData

fn accessible_text(&self, width: usize) -> String

The content as plain lines, laid out for width where layout matters.

impl Clone for TableData

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TableData

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

Formats the value using the given formatter.

impl Renderable for TableData

fn rich_render( &self, console: &Console, options: &ConsoleOptions, ) -> Vec<Segment>

fn measure(&self, console: &Console, options: &ConsoleOptions) -> Measurement

The (minimum, maximum) cell width this renderable wants. The default assumes the renderable fills the available width (e.g. Panel, Table); Text overrides it with its content width so the top-level print path can shrink to fit. Port of __rich_measure__ / Measurement.get.

fn fit_to_measurement(&self) -> bool

Whether a top-level Console::print shrinks this renderable to its measured width. Upstream renders every top-level renderable at the full console width, so the default is false; an extension may opt in.

fn vertical(&self) -> Option<VerticalAlign>

The vertical alignment a Table cell holding this renderable uses in place of its column’s. Upstream reads getattr(renderable, "vertical", None); Align sets it.

impl Transform<TableData> for Sort

fn apply(&self, data: TableData) -> Result<TableData, TransformError>

impl Transform<TableData> for Group

fn apply(&self, data: TableData) -> Result<TableData, TransformError>