Struct text_grid::Grid

pub struct Grid<R: ?Sized, S = DefaultCellsSchema<R>> { /* private fields */ }

A builder used to create plain-text table from row values.

Generate a table using the columns defined by CellsFormatter.

Examples

use text_grid::*;
struct RowData {
    a: u32,
    b: u32,
}
impl Cells for RowData {
    fn fmt(f: &mut CellsFormatter<Self>) {
        f.column("a", |s| s.a);
        f.column("b", |s| s.b);
    }
}

let mut g = Grid::new();
g.push(&RowData { a: 300, b: 1 });
g.push(&RowData { a: 2, b: 200 });

assert_eq!(format!("\n{g}"), r#"
  a  |  b  |
-----|-----|
 300 |   1 |
   2 | 200 |
"#);

Implementations

impl<R: Cells + ?Sized> Grid<R, DefaultCellsSchema<R>>

pub fn new() -> Self

Create a new Grid with DefaultCellsSchema and prepare header rows.

impl<R: ?Sized, S: CellsSchema<Source = R>> Grid<S::Source, S>

pub fn with_schema(schema: S) -> Self

Create a new Grid with specified schema and prepare header rows.

impl<R: ?Sized, S: CellsSchema<Source = R>> Grid<R, S>

pub fn push(&mut self, source: &R)

Append a row to the bottom of the grid.

pub fn push_separator(&mut self)

Append a row separator to the bottom of the grid.

Trait Implementations

impl<R: ?Sized, S> Debug for Grid<R, S>

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

Formats the value using the given formatter.

impl<R: Cells + ?Sized> Default for Grid<R, DefaultCellsSchema<R>>

fn default() -> Self

Returns the “default value” for a type.

impl<R: ?Sized, S> Display for Grid<R, S>

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

Formats the value using the given formatter.

impl<'a, R, S: CellsSchema<Source = R>> Extend<&'a R> for Grid<R, S>

fn extend<T: IntoIterator<Item = &'a R>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<R, S: CellsSchema<Source = R>> Extend<R> for Grid<R, S>

fn extend<T: IntoIterator<Item = R>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<'a, R: Cells> FromIterator<&'a R> for Grid<R>

fn from_iter<T: IntoIterator<Item = &'a R>>(iter: T) -> Self

Creates a value from an iterator.

impl<R: Cells> FromIterator<R> for Grid<R>

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

Creates a value from an iterator.