Struct grid_2d::Size

pub struct Size { /* private fields */ }

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.

Implementations

impl Size

pub 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.

pub fn x(&self) -> u32

Returns the width.

pub fn y(&self) -> u32

Returns the height.

pub fn coords(&self) -> CoordIter

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

pub 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.

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

pub fn count(&self) -> usize

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

Trait Implementations

impl<'a, 'b> Add<&'a Coord> for &'b Size

type Output = Coord

The resulting type after applying the + operator.

fn add(self, _: &'a Coord) -> Self::Output

Performs the + operation.

impl<'a> Add<&'a Coord> for Size

type Output = Coord

The resulting type after applying the + operator.

fn add(self, _: &'a Coord) -> Self::Output

Performs the + operation.

impl<'a, 'b> Add<&'a Size> for &'b Coord

type Output = Coord

The resulting type after applying the + operator.

fn add(self, size: &'a Size) -> Self::Output

Performs the + operation.

impl<'a, 'b> Add<&'a Size> for &'b Size

type Output = Size

The resulting type after applying the + operator.

fn add(self, size: &'a Size) -> Self::Output

Performs the + operation.

impl<'a> Add<&'a Size> for Coord

type Output = Coord

The resulting type after applying the + operator.

fn add(self, size: &'a Size) -> Self::Output

Performs the + operation.

impl<'a> Add<&'a Size> for Size

type Output = Size

The resulting type after applying the + operator.

fn add(self, size: &'a Size) -> Self::Output

Performs the + operation.

impl<'a> Add<Coord> for &'a Size

type Output = Coord

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<Coord> for Size

type Output = Coord

The resulting type after applying the + operator.

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

Performs the + operation.

impl<'a> Add<Size> for &'a Coord

type Output = Coord

The resulting type after applying the + operator.

fn add(self, size: Size) -> Self::Output

Performs the + operation.

impl<'a> Add<Size> for &'a Size

type Output = Size

The resulting type after applying the + operator.

fn add(self, size: Size) -> Self::Output

Performs the + operation.

impl Add<Size> for Coord

type Output = Coord

The resulting type after applying the + operator.

fn add(self, size: Size) -> Self::Output

Performs the + operation.

impl Add<Size> for Size

type Output = Size

The resulting type after applying the + operator.

fn add(self, size: Size) -> Self::Output

Performs the + operation.

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 Debug for Size

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

Formats the value using the given formatter.

impl Default for Size

fn default() -> Size

Returns the “default value” for a type.

impl<'a> Div<u32> for &'a Size

type Output = Size

The resulting type after applying the / operator.

fn div(self, rhs: u32) -> Self::Output

Performs the / operation.

impl Div<u32> for Size

type Output = Size

The resulting type after applying the / operator.

fn div(self, rhs: u32) -> Self::Output

Performs the / operation.

impl<T> DivAssign<T> for Sizewhere
    Size: Div<T, Output = Size>,

fn div_assign(&mut self, rhs: T)

Performs the /= operation.

impl From<[u32; 2]> for Size

fn from(array: [u32; 2]) -> Self

Converts to this type from the input type.

impl From<(u32, u32)> for Size

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

Converts to this type from the input type.

impl Hash for Size

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,
    Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a> Mul<u32> for &'a Size

type Output = Size

The resulting type after applying the * operator.

fn mul(self, rhs: u32) -> Self::Output

Performs the * operation.

impl Mul<u32> for Size

type Output = Size

The resulting type after applying the * operator.

fn mul(self, rhs: u32) -> Self::Output

Performs the * operation.

impl<T> MulAssign<T> for Sizewhere
    Size: Mul<T, Output = Size>,

fn mul_assign(&mut self, rhs: T)

Performs the *= operation.

impl PartialEq<Size> for Size

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

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a, 'b> Sub<&'a Coord> for &'b Size

type Output = Coord

The resulting type after applying the - operator.

fn sub(self, _: &'a Coord) -> Self::Output

Performs the - operation.

impl<'a> Sub<&'a Coord> for Size

type Output = Coord

The resulting type after applying the - operator.

fn sub(self, _: &'a Coord) -> Self::Output

Performs the - operation.

impl<'a, 'b> Sub<&'a Size> for &'b Coord

type Output = Coord

The resulting type after applying the - operator.

fn sub(self, size: &'a Size) -> Self::Output

Performs the - operation.

impl<'a, 'b> Sub<&'a Size> for &'b Size

type Output = Size

The resulting type after applying the - operator.

fn sub(self, size: &'a Size) -> Self::Output

Performs the - operation.

impl<'a> Sub<&'a Size> for Coord

type Output = Coord

The resulting type after applying the - operator.

fn sub(self, size: &'a Size) -> Self::Output

Performs the - operation.

impl<'a> Sub<&'a Size> for Size

type Output = Size

The resulting type after applying the - operator.

fn sub(self, size: &'a Size) -> Self::Output

Performs the - operation.

impl<'a> Sub<Coord> for &'a Size

type Output = Coord

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<Coord> for Size

type Output = Coord

The resulting type after applying the - operator.

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

Performs the - operation.

impl<'a> Sub<Size> for &'a Coord

type Output = Coord

The resulting type after applying the - operator.

fn sub(self, size: Size) -> Self::Output

Performs the - operation.

impl<'a> Sub<Size> for &'a Size

type Output = Size

The resulting type after applying the - operator.

fn sub(self, size: Size) -> Self::Output

Performs the - operation.

impl Sub<Size> for Coord

type Output = Coord

The resulting type after applying the - operator.

fn sub(self, size: Size) -> Self::Output

Performs the - operation.

impl Sub<Size> for Size

type Output = Size

The resulting type after applying the - operator.

fn sub(self, size: Size) -> Self::Output

Performs the - operation.

impl Copy for Size

impl Eq for Size

impl StructuralEq for Size

impl StructuralPartialEq for Size