Struct vec2d::Vec2D

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

Container for 2D data

Implementations

impl<Elem: Clone> Vec2D<Elem>

pub fn from_example(size: Size, example: &Elem) -> Vec2D<Elem>

Create a Vec2D with the given size. All elements are initialized as copies of the example element.

let vector = Vec2D::from_example(Size::new(10, 10), &42);
for (_coord, &item) in vector.iter() {
    assert_eq!(item, 42);
}

pub fn resize(&mut self, new_size: Size, value: Elem)

Resize in-place so that size() is equal to new_size

impl<Elem> Vec2D<Elem>

pub fn from_vec(size: Size, src: Vec<Elem>) -> Option<Vec2D<Elem>>

Create a Vec2D with the given size. The contents are set to src. None is returned if the size does not match the length of src.

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

Returns element at the given coord or None if the coord is outside the Vec2D

Example

let v = Vec2D::from_vec (
  Size { width: 3, height: 3 },
  vec!['a','b','c','d','e','f','g','h','i']
).unwrap();
assert_eq!(v.get (Coord { x: 1, y: 0 }), Some(&'b'));
assert_eq!(v.get (Coord { x: 1, y: 2 }), Some(&'h'));
assert_eq!(v.get (Coord { x: 3, y: 0 }), None);

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

Returns a mutable reference to the element at the given coord or None if the coord is outside the Vec2D

Example

let mut v = Vec2D::from_vec (
  Size { width: 3, height: 3 },
  vec!['a','b','c','d','e','f','g','h','i']
).unwrap();
assert_eq!(v.get_mut (Coord { x: 1, y: 0 }), Some(&mut 'b'));
assert_eq!(v.get_mut (Coord { x: 1, y: 2 }), Some(&mut 'h'));
assert_eq!(v.get_mut (Coord { x: 3, y: 0 }), None);

pub fn rect(&self) -> Rect

Shortcut for self.size.rect()

pub fn size(&self) -> Size

Width and height

pub fn iter(&self) -> RectIter<'_, Elem>

Iterator over the entire Vec2D.

pub fn rect_iter(&self, rect: Rect) -> Option<RectIter<'_, Elem>>

Create an iterator over a rectangular region of the Vec2D. None is returned if the given rect does not fit entirely within the Vec2D.

pub fn rect_iter_at(
    &self,
    rect: Rect,
    start: Coord
) -> Option<RectIter<'_, Elem>>

Create an iterator over a rectangular region of the Vec2D with the start coord. None is returned if the given rect does not fit entirely within the Vec2D or if the start coord is not within rect.

pub fn iter_mut(&mut self) -> RectIterMut<'_, Elem>

Mutable iterater over the entire Vec2D.

pub fn rect_iter_mut(&mut self, rect: Rect) -> Option<RectIterMut<'_, Elem>>

Create a mutable iterator over a rectangular region of the Vec2D. None is returned if the given rect does not fit entirely within the Vec2D.

pub fn rect_iter_mut_at(
    &mut self,
    rect: Rect,
    start: Coord
) -> Option<RectIterMut<'_, Elem>>

Create a mutable iterator over a rectangular region of the Vec2D with the start coord. None is returned if the given rect does not fit entirely within the Vec2D or if the start coord is not within rect.

Trait Implementations

impl<T: Clone> Clone for Vec2D<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Vec2D<T>

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

Formats the value using the given formatter.

impl<T: Hash> Hash for Vec2D<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: PartialEq> PartialEq<Vec2D<T>> for Vec2D<T>

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

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

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

This method tests for !=.

impl<T: Eq> Eq for Vec2D<T>

impl<T> StructuralEq for Vec2D<T>

impl<T> StructuralPartialEq for Vec2D<T>