Struct Grid 

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

A width × height grid of T, stored row-major.

Indexing is (x, y): grid[(x, y)] reads the cell at column x, row y.

Implementations

impl<T: Clone> Grid<T>

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

Creates a grid filled with value.

Panics

Panics if either dimension is 0.

impl<T> Grid<T>

pub fn from_vec(width: usize, height: usize, data: Vec<T>) -> Self

Wraps an existing row-major buffer.

Panics

Panics if data.len() != width * height or either dimension is 0.

pub fn width(&self) -> usize

Grid width in cells.

pub fn height(&self) -> usize

Grid height in cells.

pub fn len(&self) -> usize

Total number of cells (width * height).

pub fn is_empty(&self) -> bool

Always false: grids have positive dimensions by construction.

pub fn idx(&self, x: usize, y: usize) -> usize

Flat index of (x, y).

Callers holding flat indices (e.g. from Self::as_slice) can map back with Self::coords.

pub fn coords(&self, idx: usize) -> (usize, usize)

(x, y) coordinates of a flat index.

pub fn as_slice(&self) -> &[T]

The underlying row-major buffer.

pub fn as_mut_slice(&mut self) -> &mut [T]

The underlying row-major buffer, mutably.

pub fn into_vec(self) -> Vec<T>

Consumes the grid, returning the row-major buffer.

pub fn iter(&self) -> Iter<'_, T>

Iterates over all cells in row-major order.

pub fn iter_mut(&mut self) -> IterMut<'_, T>

Iterates mutably over all cells in row-major order.

Trait Implementations

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

fn clone(&self) -> Self

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> Index<(usize, usize)> for Grid<T>

type Output = T

The returned type after indexing.

fn index(&self, (x, y): (usize, usize)) -> &T

Performs the indexing (container[index]) operation.

impl<T> IndexMut<(usize, usize)> for Grid<T>

fn index_mut(&mut self, (x, y): (usize, usize)) -> &mut T

Performs the mutable indexing (container[index]) operation.

impl<'a, T> IntoIterator for &'a Grid<T>

type Item = &'a T

The type of the elements being iterated over.

type IntoIter = Iter<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

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

fn eq(&self, other: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.

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