Struct ResultSet 

pub struct ResultSet<S = Rows> { /* private fields */ }

A query result: columns, their types and rows; see the module docs.

Implementations

impl ResultSet<Rows>

pub fn new(rows: Rows) -> Self

Rows held in memory, typed by their schema.

impl ResultSet<RowWindow>

pub fn read( source: impl RowSource, offset: usize, limit: usize, ) -> Result<Self, DataError>

One pass over source, keeping the limit rows from offset and counting the rest: any length of input in one window of memory.

pub fn window(window: RowWindow) -> Self

A window already read.

impl<S: VirtualRows> ResultSet<S>

pub fn from_parts( columns: impl IntoIterator<Item = impl Into<String>>, schema: Option<Schema>, source: S, ) -> Self

Rows from any source under columns, typed by schema (one field per column, matched by name, else by position).

pub fn offset(self, offset: usize) -> Self

Show rows from offset (0-based).

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

Show at most rows rows (default DEFAULT_LIMIT, at most MAX_HEIGHT).

pub fn elapsed(self, elapsed: Duration) -> Self

How long the query took, for the footer.

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

The marker for null cells (default NULL).

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

A title above the table (console markup).

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

The column names.

pub fn schema(&self) -> Option<&Schema>

The schema the columns are typed by.

pub fn source(&self) -> &S

The source.

pub fn row_count(&self) -> Option<usize>

How many rows the result has, when the source knows.

pub fn footer(&self, ascii: bool) -> String

The footer: (3 rows), (1 row), (1,001+ rows) when the source cannot count past the window, with the elapsed time when given ((3 rows, 12ms)).

pub fn is_windowed(&self) -> bool

Whether the table shows only part of the rows.

pub fn to_virtual_table(&self) -> VirtualTable<&S>

The result as a virtualised table (without the footer), typed and with nulls marked; change its frame with its builders.

Trait Implementations

impl<S: Clone> Clone for ResultSet<S>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S: Debug> Debug for ResultSet<S>

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

Formats the value using the given formatter.

impl<S: VirtualRows> Renderable for ResultSet<S>

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. Port of __rich_measure__. The default is what upstream’s Measurement.get returns for a renderable without one: anything from nothing to the whole width, (0, max_width).

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.

fn print_end_line(&self, _options: &ConsoleOptions) -> bool

Whether a top-level print ends this renderable’s last line. This port’s renderables separate lines, where upstream’s end each line with "\n", so a print adds the final line break. A renderable whose upstream output stops without one (Screen, LiveRender, a Rule whose end has no newline) returns false, and the next output continues its last line. options are the print’s options.