Skip to main content

Rectangle

Struct Rectangle 

Source
pub struct Rectangle {
    pub coordinate: Coordinate,
    pub dimensions: Dimensions,
}
Expand description

Rectangle defined by inclusive minimum and maximum coordinates.

let rectangle = Rectangle::from (((1, 2).into(), (5, 3).into()));
assert_eq!(rectangle.height(), 5);
assert_eq!(rectangle.width(),  3);
assert_eq!(rectangle.height(), rectangle.dimensions.rows);
assert_eq!(rectangle.width(),  rectangle.dimensions.columns);
assert_eq!(rectangle.contains ((0, 0).into()), false);
assert_eq!(rectangle.contains ((4, 3).into()), true);

Fields§

§coordinate: Coordinate§dimensions: Dimensions

Implementations§

Source§

impl Rectangle

Source

pub const fn width(&self) -> usize

Source

pub const fn height(&self) -> usize

Source

pub const fn min(&self) -> Coordinate

Source

pub const fn max(&self) -> Coordinate

Max is inclusive: this is the lower right corner element of the rectangle

Source

pub const fn upper_left(&self) -> Coordinate

Source

pub const fn upper_right(&self) -> Coordinate

Source

pub const fn lower_right(&self) -> Coordinate

Source

pub const fn lower_left(&self) -> Coordinate

Source

pub fn row(&self, row: usize) -> Option<Self>

Source

pub fn column(&self, column: usize) -> Option<Self>

Source

pub const fn area(&self) -> usize

Rows * columns

Source

pub fn contains(&self, _: Coordinate) -> bool

Return true if the coordinate is between min and max (inclusive)

Source

pub fn contains_rc(&self, row: usize, column: usize) -> bool

Source

pub fn iter(&self) -> impl Iterator<Item = Coordinate>

Trait Implementations§

Source§

impl Clone for Rectangle

Source§

fn clone(&self) -> Rectangle

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Rectangle

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Rectangle

Source§

fn default() -> Rectangle

Returns the “default value” for a type. Read more
Source§

impl Eq for Rectangle

Source§

impl From<(Coordinate, Dimensions)> for Rectangle

Source§

fn from((coordinate, dimensions): (Coordinate, Dimensions)) -> Self

Converts to this type from the input type.
Source§

impl From<Dimensions> for Rectangle

Source§

fn from(dimensions: Dimensions) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for Rectangle

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for Rectangle

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.