Struct Rectangle 

pub struct Rectangle<Space: CoordinateSpace> {
    pub top_left: Coordinates<Space>,
    pub bottom_right: Coordinates<Space>,
}

A 2d rectangle specified with two Coordinates

Fields

top_left: Coordinates<Space>

Top left Coordinates of the rectangle

bottom_right: Coordinates<Space>

Bottom right Coordinates of the rectangle

Implementations

impl<Space: CoordinateSpace> Rectangle<Space>

pub const fn new( top_left: Coordinates<Space>, bottom_right: Coordinates<Space>, ) -> Self

Creates a new rectangle using two Coordinates

pub const fn new_from_coordinates( left: Space::Data, top: Space::Data, right: Space::Data, bottom: Space::Data, ) -> Self

A shortcut for Rectangle::new without having to use Coordinates::new(x, y)

pub fn rotated(&self, rotation: u8) -> Self

Returns a new rectangle that is rotated a number of 90 degree turns around the center of the CoordinateSpace

pub const fn everything() -> Self

Creates a new rectangle that covers the entire CoordinateSpace

pub fn width(&self) -> Space::Data

Calculates the width of the rectangle

pub fn height(&self) -> Space::Data

Calculates the height of the rectangle

pub const fn left(&self) -> Space::Data

Returns the leftmost X coordinate of the rectangle

pub const fn top(&self) -> Space::Data

Returns the topmost Y coordinate of the rectangle

pub const fn right(&self) -> Space::Data

Returns the rightmost X coordinate of the rectangle

pub const fn bottom(&self) -> Space::Data

Returns the bottommost Y coordinate of the rectangle

pub fn iter_coords( &self, ) -> impl Iterator<Item = Coordinates<Space>> + use<'_, Space>

Produces a row-first iterator of every coordinate contained within this rectangle

Trait Implementations

impl<Space: Clone + CoordinateSpace> Clone for Rectangle<Space>

fn clone(&self) -> Rectangle<Space>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Space> Debug for Rectangle<Space>

where Space: Debug + CoordinateSpace, Space::Data: Debug,

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

Formats the value using the given formatter.

impl<Space: PartialEq + CoordinateSpace> PartialEq for Rectangle<Space>

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl<Space: PartialOrd + CoordinateSpace> PartialOrd for Rectangle<Space>

fn partial_cmp(&self, other: &Rectangle<Space>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<Space: Copy + CoordinateSpace> Copy for Rectangle<Space>

impl<Space: Eq + CoordinateSpace> Eq for Rectangle<Space>

impl<Space: CoordinateSpace> StructuralPartialEq for Rectangle<Space>