Struct Grid

pub struct Grid { /* private fields */ }

Everything needed to format the cells with the grid options.

For more information, see the term_grid crate documentation.

Implementations

impl Grid

pub fn new(options: GridOptions) -> Self

Creates a new grid view with the given options.

Examples found in repository

examples/basic.rs (lines 15-18)

fn main() {
    let mut grid = Grid::new(GridOptions {
        direction:  Direction::TopToBottom,
        filling:    Filling::Text(" | ".into()),
    });

    for i in 0..48 {
        let mut cell = Cell::from(format!("{}", 2_isize.pow(i)));
        cell.alignment = Alignment::Right;
        grid.add(cell)
    }

    if let Some(grid_display) = grid.fit_into_width(80) {
        println!("{}", grid_display);
    }
    else {
        println!("Couldn't fit grid into 80 columns!");
    }
}

pub fn reserve(&mut self, additional: usize)

Reserves space in the vector for the given number of additional cells to be added. (See the Vec::reserve function.)

pub fn add(&mut self, cell: Cell)

Adds another cell onto the vector.

Examples found in repository

examples/basic.rs (line 23)

fn main() {
    let mut grid = Grid::new(GridOptions {
        direction:  Direction::TopToBottom,
        filling:    Filling::Text(" | ".into()),
    });

    for i in 0..48 {
        let mut cell = Cell::from(format!("{}", 2_isize.pow(i)));
        cell.alignment = Alignment::Right;
        grid.add(cell)
    }

    if let Some(grid_display) = grid.fit_into_width(80) {
        println!("{}", grid_display);
    }
    else {
        println!("Couldn't fit grid into 80 columns!");
    }
}

pub fn fit_into_width(&self, maximum_width: Width) -> Option<Display<'_>>

Returns a displayable grid that’s been packed to fit into the given width in the fewest number of rows.

Returns None if any of the cells has a width greater than the maximum width.

Examples found in repository

examples/basic.rs (line 26)

fn main() {
    let mut grid = Grid::new(GridOptions {
        direction:  Direction::TopToBottom,
        filling:    Filling::Text(" | ".into()),
    });

    for i in 0..48 {
        let mut cell = Cell::from(format!("{}", 2_isize.pow(i)));
        cell.alignment = Alignment::Right;
        grid.add(cell)
    }

    if let Some(grid_display) = grid.fit_into_width(80) {
        println!("{}", grid_display);
    }
    else {
        println!("Couldn't fit grid into 80 columns!");
    }
}

pub fn fit_into_columns(&self, num_columns: usize) -> Display<'_>

Returns a displayable grid with the given number of columns, and no maximum width.

Trait Implementations

impl Debug for Grid

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

Formats the value using the given formatter.

impl PartialEq for Grid

fn eq(&self, other: &Grid) -> 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 StructuralPartialEq for Grid