Struct gridd::Grid

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

Two-dimensional, non-resizeable, zero-indexed grid.

Methods

impl<T> Grid<T> where
    T: Copy, 

pub fn new(col_count: usize, row_count: usize, default: T) -> Self

Create a new Grid populated with a default value.

pub fn square(side_len: usize, default: T) -> Self

Create a new Grid in a square shape, populated with a default value.

pub fn transpose(&self) -> Self

Perform a transposition.

impl<T> Grid<T>

pub fn col_count(&self) -> usize

Get a Grid's column count.

pub fn row_count(&self) -> usize

Get a Grid's row count.

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

Get an immutable reference to some cell.

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

Get a mutable reference to some cell.

pub fn rget(&self, anchor: Coord, vec: Offset) -> Option<&T>

Get an immutable reference to the cell with the given positional relationship to the provided coordinate.

pub fn rget_mut(&mut self, anchor: Coord, vec: Offset) -> Option<&mut T>

Get a mutable reference to the cell with the given positional relationship to the provided coordinate.

pub fn set(&mut self, coord: Coord, new_val: T)

Set a cell's value.

pub fn rset(&mut self, coord: Coord, vec: Offset, new_val: T)

Set the value of a cell with the given positional relationship to the provided coordinate.

pub fn contains(&self, (col, row): Coord) -> bool

Determine if a coordinate is within the grid

Trait Implementations

impl<T: Eq> Eq for Grid<T>

impl<T: Default> Default for Grid<T>

fn default() -> Grid<T>

Returns the "default value" for a type.

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: PartialOrd> PartialOrd<Grid<T>> for Grid<T>

fn partial_cmp(&self, other: &Grid<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Grid<T>) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Grid<T>) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Grid<T>) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Grid<T>) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T: Ord> Ord for Grid<T>

fn cmp(&self, other: &Grid<T>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

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

fn eq(&self, other: &Grid<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Grid<T>) -> bool

This method tests for !=.

impl<T: Hash> Hash for Grid<T>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

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

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

Formats the value using the given formatter.