Struct tabled::tables::IterTable

pub struct IterTable<I> { /* private fields */ }

Available on crate feature std only.

A table which consumes an IntoRecords iterator.

To be able to build table we need a dimensions. If no width and count_columns is set, IterTable will sniff the records, by keeping a number of rows buffered (You can set the number via IterTable::sniff).

Implementations

impl<I> IterTable<I>

pub fn new(iter: I) -> Self

where I: IntoRecords,

Creates a new IterTable structure.

pub fn with<O>(self, option: O) -> Self

where for<'a> O: TableOption<IterRecords<&'a I>, CompactConfig, StaticDimension>,

With is a generic function which applies options to the IterTable.

pub fn columns(self, count_columns: usize) -> Self

Limit a number of columns.

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

Limit a number of rows.

pub fn sniff(self, count: usize) -> Self

Limit an amount of rows will be read for dimension estimations.

pub fn height(self, size: usize) -> Self

Set a height for each row.

pub fn width(self, size: usize) -> Self

Set a width for each column.

pub fn to_string(self) -> String

where I: IntoRecords, I::Cell: AsRef<str>,

Build a string.

We can’t implement std::string::ToString cause it does takes &self reference.

pub fn build<W>(self, writer: W) -> Result<()>

where W: Write, I: IntoRecords, I::Cell: AsRef<str>,

Format table into io::Writer.

pub fn fmt<W>(self, writer: W) -> Result

where W: Write, I: IntoRecords, I::Cell: AsRef<str>,

Format table into fmt::Writeer.

Trait Implementations

impl<I: Clone> Clone for IterTable<I>

fn clone(&self) -> IterTable<I>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<I: Debug> Debug for IterTable<I>

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

Formats the value using the given formatter.