Struct grid_2d::Grid

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

Methods

impl<T> Grid<T>

pub fn new_fn<F>(size: Size, f: F) -> Self where
    F: FnMut(Coord) -> T, 

pub fn try_new_iterator<I>(
    size: Size,
    iterator: I
) -> Result<Self, IteratorLengthDifferentFromSize> where
    I: Iterator<Item = T>, 

pub fn new_iterator<I>(size: Size, iterator: I) -> Self where
    I: Iterator<Item = T>, 

pub fn new_grid_map_with_coord<U, F>(grid: Grid<U>, f: F) -> Self where
    F: FnMut(Coord, U) -> T, 

pub fn new_grid_map<U, F>(grid: Grid<U>, f: F) -> Self where
    F: FnMut(U) -> T, 

pub fn new_grid_map_ref<U, F>(grid: &Grid<U>, f: F) -> Self where
    F: FnMut(&U) -> T, 

pub fn new_grid_map_ref_with_coord<U, F>(grid: &Grid<U>, f: F) -> Self where
    F: FnMut(Coord, &U) -> T, 

impl<T: Clone> Grid<T>

pub fn new_clone(size: Size, value: T) -> Self

impl<T: Default> Grid<T>

pub fn new_default(size: Size) -> Self

impl<T> Grid<T>

pub fn width(&self) -> u32

pub fn height(&self) -> u32

pub fn size(&self) -> Size

pub fn iter(&self) -> GridIter<T>

pub fn iter_mut(&mut self) -> GridIterMut<T>

Important traits for CoordIter

impl Iterator for CoordIter type Item = Coord;

pub fn coord_iter(&self) -> CoordIter

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

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

pub fn get_tiled(&self, coord: Coord) -> &T

pub fn get_tiled_mut(&mut self, coord: Coord) -> &mut T

pub fn index_of_coord_unchecked(&self, coord: Coord) -> usize

pub fn index_of_coord(&self, coord: Coord) -> Option<usize>

pub fn get_index_checked(&self, index: usize) -> &T

pub fn get_index_checked_mut(&mut self, index: usize) -> &mut T

pub fn get_checked(&self, coord: Coord) -> &T

pub fn get_checked_mut(&mut self, coord: Coord) -> &mut T

pub fn enumerate(&self) -> GridEnumerate<T>

pub fn enumerate_mut(&mut self) -> GridEnumerateMut<T>

pub fn into_enumerate(self) -> GridIntoEnumerate<T>

pub fn rows(&self) -> GridRows<T>

pub fn rows_mut(&mut self) -> GridRowsMut<T>

pub fn get2_mut(
    &mut self,
    a: Coord,
    b: Coord
) -> Result<(&mut T, &mut T), Get2Error>

pub fn get2_checked_mut(&mut self, a: Coord, b: Coord) -> (&mut T, &mut T)

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

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

Trait Implementations

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: Eq> Eq for Grid<T>

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: 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: Debug> Debug for Grid<T>

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

Formats the value using the given formatter.

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> StructuralPartialEq for Grid<T>

impl<T> StructuralEq for Grid<T>