Struct IterTable

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

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).

In contrast to Table IterTable does no allocations but it consumes an iterator. It’s useful when you don’t want to re/allocate a buffer for your data.

Example

use tabled::{grid::records::IterRecords, tables::IterTable};
use tabled::assert::assert_table;

let data = vec![
    vec!["First", "row"],
    vec!["Second", "row"],
    vec!["Third", "big \n multiline row"],
];

let records = IterRecords::new(data, 2, Some(2));
let mut table = IterTable::new(records);
table.sniff(1);

// notice because of sniff 1 we have all rows after the first one being truncated
assert_table!(
    table.to_string(),
    "+-------+-----+"
    "| First | row |"
    "+-------+-----+"
    "| Secon | row |"
    "+-------+-----+"
    "| Third | big |"
    "+-------+-----+"
);

Implementations

impl<I> IterTable<I>

pub fn new(iter: I) -> Self

where I: IntoRecords,

Creates a new IterTable structure.

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

where O: TableOption<I, CompactConfig, ZeroDimension>,

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

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

Limit a number of columns.

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

Limit a number of rows.

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

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

By default it’s 1000.

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

Set a height for each row.

pub fn width(&mut self, size: usize) -> &mut 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 duplicate 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.

impl<T> FromIterator<T> for IterTable<Vec<Vec<T::Item>>>

where T: IntoIterator, T::Item: AsRef<str>,

fn from_iter<I: IntoIterator<Item = T>>(iter: I) -> Self

Creates a value from an iterator.

impl<I: Hash> Hash for IterTable<I>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<I: Ord> Ord for IterTable<I>

fn cmp(&self, other: &IterTable<I>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<I: PartialEq> PartialEq for IterTable<I>

fn eq(&self, other: &IterTable<I>) -> 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<I: PartialOrd> PartialOrd for IterTable<I>

fn partial_cmp(&self, other: &IterTable<I>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<I: Eq> Eq for IterTable<I>

impl<I> StructuralPartialEq for IterTable<I>