Struct ingrid::Size

pub struct Size {
    pub width: usize,
    pub height: usize,
}

A two-dimensional size

This structure defines a basic two-dimensional size to specify the dimension of grids. It enables copy semantics to avoid handling ownership and references throughout your code for no significant performance. Also, in practice, you use the size! macro helper to instantiate sizes; this is to be consistent with the use of coordinates.

Examples

// Create a size to specify the dimension of a grid.
let mut size1 = size!(24, 42);

// Copy the size into another variable.
let size2 = size1;

// The first variable is still accessible.
size1.width = 42;
size1.height = 0;

// Additionally, you could also type the following.
let size3 = Size::zero();

Fields

width: usize

The width of the size.

height: usize

The height of the size.

Methods

impl Size

pub fn new(width: usize, height: usize) -> Size

Construct a new size.

This function constructs a new coordinate from given width and height values.

Examples

let size = Size::new(24, 42);

assert_eq!(size.width, 24);
assert_eq!(size.height, 42);

pub fn zero() -> Size

Construct a zero size.

This function constructs a 'zero' size which is a coordinate with both width and height values set at 0.

Examples

let size = Size::zero();

assert_eq!(size.width, 0);
assert_eq!(size.height, 0);

Trait Implementations

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

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

Formats the value using the given formatter.

impl Eq for Size

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: &Size) -> bool

This method tests for !=.

impl StructuralEq for Size

impl StructuralPartialEq for Size