Struct Grid 

#[non_exhaustive]
pub struct Grid<T> {
    pub width: usize,
    pub height: usize,
    pub cells: Vec<T>,
    pub dead_glyph: char,
    pub alive_glyph: char,
    pub population: usize,
}

Grid holds the state for a Conways game of life

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

width: usize

The width of the grid to be created

height: usize

The height of the grid to be created

cells: Vec<T>

The state of the grid in terms of what cells are alive and dead in automaton

dead_glyph: char

What character glyph should be used to display a dead population

alive_glyph: char

What character glyph should be used to display an alive population

population: usize

Population of the grid i.e number of alive cells

Implementations

impl Grid<CellState>

pub fn new_empty(width: usize, height: usize) -> Self

Create a new Grid of a given width and height. It will default to X for alive glyph and for dead glyph

use gridlife::Grid;
let grid = Grid::new_empty(3, 3);

pub fn new_random(width: usize, height: usize) -> Self

Generate a new Grid of a given width and height It will be populated with a random distribution of Alive/Dead cells The default glyphs of X for alive and for dead.

use gridlife::Grid;
let grid = Grid::new_random(3, 3);

pub fn new_random_custom_glyphs( width: usize, height: usize, alive_glyph: char, dead_glyph: char, ) -> Self

Generate a new Grid of a given width and height It will be populated with a random distribution of Alive/Dead cells The glyphs can be overriddne with alive_glyph and dead_glyph

use gridlife::Grid;
let grid = Grid::new_random_custom_glyphs(3, 3, '1', '0');

pub fn update_states(&mut self) -> &[CellState]

Re-generates the state of the Grid cells based on the rules of Conways game of life

Trait Implementations

impl<T: Debug> Debug for Grid<T>

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

Formats the value using the given formatter.

impl Default for Grid<CellState>

fn default() -> Self

Returns the “default value” for a type.

impl Display for Grid<CellState>

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

Formats the value using the given formatter.