Struct grid_2d::Grid

pub struct Grid<T, C: CoordSystem = XThenY> { /* fields omitted */ }

Methods

impl<T, C: CoordSystem> Grid<T, C>

pub fn new_fn_with_coord_system<F>(coord_system: C, f: F) -> Self where     F: FnMut(Coord) -> T,

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

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

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

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

impl<T: Clone, C: CoordSystem> Grid<T, C>

pub fn new_clone_with_coord_system(coord_system: C, value: T) -> Self

impl<T: Default, C: CoordSystem> Grid<T, C>

pub fn new_default_with_coord_system(coord_system: C) -> Self

impl<T> Grid<T, XThenY>

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

impl<T: Clone> Grid<T, XThenY>

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

impl<T: Default> Grid<T, XThenY>

pub fn new_default(size: Size) -> Self

impl<T, C: CoordSystem> Grid<T, C>

pub fn width(&self) -> u32

pub fn height(&self) -> u32

pub fn size(&self) -> Size

pub fn len(&self) -> usize

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

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

pub fn coord_iter(&self) -> C::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(&self, coord: Coord) -> Option<usize>

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

pub fn get_index_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, C::CoordIter>

pub fn enumerate_mut(&mut self) -> GridEnumerateMut<T, C::CoordIter>

pub fn into_enumerate(self) -> GridIntoEnumerate<T, C::CoordIter>

Trait Implementations

impl<T: PartialEq, C: PartialEq + CoordSystem> PartialEq<Grid<T, C>> for Grid<T, C>

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

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

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

This method tests for !=.

impl<T: Eq, C: Eq + CoordSystem> Eq for Grid<T, C>

impl<T: PartialOrd, C: PartialOrd + CoordSystem> PartialOrd<Grid<T, C>> for Grid<T, C>

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

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

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

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

fn le(&self, other: &Grid<T, C>) -> 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, C>) -> bool

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

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

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

impl<T: Ord, C: Ord + CoordSystem> Ord for Grid<T, C>

fn cmp(&self, other: &Grid<T, C>) -> 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.

impl<T: Clone, C: Clone + CoordSystem> Clone for Grid<T, C>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T, C: CoordSystem> IntoIterator for Grid<T, C>

type Item = T

The type of the elements being iterated over.

type IntoIter = GridIntoIter<T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T: Debug, C: Debug + CoordSystem> Debug for Grid<T, C>

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

Formats the value using the given formatter.

impl<T: Hash, C: Hash + CoordSystem> Hash for Grid<T, C>

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

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, C: CoordSystem> Index<usize> for Grid<T, C>

type Output = T

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<T, C: CoordSystem> IndexMut<usize> for Grid<T, C>

fn index_mut(&mut self, index: usize) -> &mut Self::Output

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