Struct grid_2d::Size

pub struct Size { /* fields omitted */ }

A size cannot be created which would contain un-addressable cells. That is, the maximum size has a width and height of one greater than the maximum i32.

Methods

impl Size

fn new(x: u32, y: u32) -> Self

Creates a new Size. Panics if x or y is greater than ::std::i32::MAX as u32 + 1.

fn x(&self) -> u32

Returns the width.

fn y(&self) -> u32

Returns the height.

fn coords(&self) -> CoordIter

Returns an iterator over all the coordinates within a rectangle of this size.

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

Suppose an array is used to implement a 2D grid of this size, where traversing the array from start to end is equivalent to traversing the 2D grid top to bottom, traversing left to right within each row. If a given coordinate is valid for such a grid, this function returns the index into the array corresponding to that coordinate.

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

fn count(&self) -> usize

Return the number of cells in a 2D grid of this size.

Trait Implementations

impl Debug for Size

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

Formats the value using the given formatter.

impl Clone for Size

fn clone(&self) -> Size

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Size

impl Hash for Size

fn hash<__H: Hasher>(&self, __arg_0: &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 PartialEq for Size

fn eq(&self, __arg_0: &Size) -> bool

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

fn ne(&self, __arg_0: &Size) -> bool

This method tests for !=.

impl Eq for Size

impl Default for Size

fn default() -> Size

Returns the "default value" for a type.

impl<T: Into<[u32; 2]>> From<T> for Size

fn from(t: T) -> Self

Performs the conversion.

impl<T: Into<Size>> Add<T> for Size

type Output = Size

The resulting type after applying the + operator.

fn add(self, rhs: T) -> Self::Output

Performs the + operation.

impl Add<Coord> for Size

type Output = Coord

The resulting type after applying the + operator.

fn add(self, rhs: Coord) -> Self::Output

Performs the + operation.

impl<T: Into<Size>> Sub<T> for Size

type Output = Size

The resulting type after applying the - operator.

fn sub(self, rhs: T) -> Self::Output

Performs the - operation.

impl Sub<Coord> for Size

type Output = Coord

The resulting type after applying the - operator.

fn sub(self, rhs: Coord) -> Self::Output

Performs the - operation.