Struct prototty::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) -> Size

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

impl Hash for Size

fn hash<__H>(&self, __arg_0: &mut __H) where
    __H: Hasher, 

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

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

fn from(t: T) -> Size

impl PartialEq<Size> 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<T> Add<T> for Size where
    T: Into<Size>, 

type Output = Size

fn add(self, rhs: T) -> <Size as Add<T>>::Output

impl Add<Coord> for Size

type Output = Coord

fn add(self, rhs: Coord) -> <Size as Add<Coord>>::Output

impl<'de> Deserialize<'de> for Size

fn deserialize<__D>(
    __deserializer: __D
) -> Result<Size, <__D as Deserializer<'de>>::Error> where
    __D: Deserializer<'de>, 

impl Debug for Size

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

Formats the value using the given formatter.

impl Serialize for Size

fn serialize<__S>(
    &self,
    __serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

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

type Output = Size

fn sub(self, rhs: T) -> <Size as Sub<T>>::Output

impl Sub<Coord> for Size

type Output = Coord

fn sub(self, rhs: Coord) -> <Size as Sub<Coord>>::Output

impl Default for Size

fn default() -> Size