Struct StreamingTable 

pub struct StreamingTable<K> { /* private fields */ }

Keyed rows rendered incrementally; see the module docs.

K is the stable row key (a job id, a path, a sequence number). Cells are Values shown through each Column’s formatter; the frame (title, caption, box, edges, expand, border style) is set with the same builders as TableData.

Implementations

impl<K> StreamingTable<K>

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<K: Eq + Hash + Clone> StreamingTable<K>

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

An empty table under columns.

pub fn window(self, window: Window) -> Self

Show only part of the rows.

pub fn set_window(&mut self, window: Window)

Change the window.

pub fn capacity(self, rows: usize) -> Self

Keep at most rows rows: inserting beyond that evicts the oldest (first inserted). Evicted rows count as earlier rows in the indicator.

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

Show rows sorted by keys (stable over insertion order, empty cells last), with header indicators; an empty list restores insertion order. Sorting reorders cached rows without re-rendering them.

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

Builder form of set_sort.

pub fn upsert(&mut self, key: K, row: impl IntoIterator<Item = Value>) -> bool

Insert a row, or replace the row under key in place (it keeps its position). Returns true when the key is new. Missing cells are Null; extra cells are dropped. Writing identical values is not a change and does not re-render the row.

pub fn update_cell( &mut self, key: &K, column: usize, value: impl Into<Value>, ) -> bool

Set one cell of the row under key. Returns false when there is no such row or column.

pub fn remove(&mut self, key: &K) -> Option<Vec<Value>>

Remove the row under key, returning its cells.

pub fn clear(&mut self)

Remove every row (the evicted count is kept).

pub fn get(&self, key: &K) -> Option<&[Value]>

The cells of the row under key.

pub fn contains_key(&self, key: &K) -> bool

Whether a row is stored under key.

pub fn len(&self) -> usize

The number of stored rows (shown or not).

pub fn is_empty(&self) -> bool

Whether no rows are stored.

pub fn evicted(&self) -> u64

How many rows capacity has evicted.

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

The columns.

pub fn rows(&self) -> impl Iterator<Item = (&K, &[Value])> + '_

Stored rows in insertion order.

pub fn stats(&self) -> RenderStats

Render-cache counters since creation (or reset_stats).

pub fn reset_stats(&self)

Zero the counters.

pub fn invalidate(&self)

Drop every cached row so the next frame renders from scratch. Needed only when rendering to a console with a different theme, since cached lines keep the styles they were rendered with.

pub fn to_data(&self) -> TableData

A snapshot of every stored row, in display order, with the same columns and sort — for grouping and aggregates.

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

The shown rows as one core table, rendered from scratch (without the window’s indicator lines).

Trait Implementations

impl<K: Eq + Hash + Clone> AccessibleText for StreamingTable<K>

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

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

impl<K> Debug for StreamingTable<K>

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

Formats the value using the given formatter.

impl<K: Eq + Hash + Clone> Renderable for StreamingTable<K>

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.