Struct Grid

pub struct Grid<T> { /* private fields */ }

👎Deprecated since 0.1.4: Use DynamicGrid instead

A 2d fixed-size grid containers for cells of type T

Implementations

impl<T: Default> Grid<T>

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

Create a grid using the default value of T for each cell

Example

let grid: Grid<i32> = Grid::new(2, 2);
assert_eq!(grid.get([0, 0]), Some(&0));
assert_eq!(grid.get([1, 0]), Some(&0));
assert_eq!(grid.get([0, 1]), Some(&0));
assert_eq!(grid.get([1, 1]), Some(&0));

impl<T> Grid<T>

pub fn new_with( width: usize, height: usize, init_cell: impl FnMut(Coord) -> T, ) -> Self

Create a grid using init_cell function for each cell

Example

let grid = Grid::new_with(2, 2, |coord| coord);
assert_eq!(grid.get([0, 0]), Some(&Coord { x: 0, y: 0 }));
assert_eq!(grid.get([1, 0]), Some(&Coord { x: 1, y: 0 }));
assert_eq!(grid.get([0, 1]), Some(&Coord { x: 0, y: 1 }));
assert_eq!(grid.get([1, 1]), Some(&Coord { x: 1, y: 1 }));

pub fn from_row_major_iter( width: usize, iter: impl IntoIterator<Item = T>, ) -> Self

Create a grid using the row-major iter

Example

let grid = Grid::from_row_major_iter(2, [1, 2, 3, 4]);
assert_eq!(grid.get([0, 0]), Some(&1));
assert_eq!(grid.get([1, 0]), Some(&2));
assert_eq!(grid.get([0, 1]), Some(&3));
assert_eq!(grid.get([1, 1]), Some(&4));

pub fn get(&self, coord: impl Into<Coord>) -> Option<&T>

Access the cell at coord

Returns None if the coord is out of bounds

pub fn get_mut(&mut self, coord: impl Into<Coord>) -> Option<&mut T>

Access mutably the cell at coord

Returns None if the coord is out of bounds

pub fn set(&mut self, coord: impl Into<Coord>, value: T)

Set the value of the cell at coord

Panics

Panics if the coord is out-of-bounds

For a non-panicking version, use get_mut

pub fn cells(&self) -> impl Iterator<Item = &T>

Iterator over all cells

pub fn cells_in_rect(&self, rect: impl Into<Rect>) -> impl Iterator<Item = &T>

Iterator over cells in rect

Trait Implementations

impl<T: Clone> Clone for Grid<T>

fn clone(&self) -> Grid<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

impl<T: PartialEq> PartialEq for Grid<T>

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

impl<T> StructuralPartialEq for Grid<T>