Struct Rect 

pub struct Rect {
    pub x: u16,
    pub y: u16,
    pub width: u16,
    pub height: u16,
}

An axis-aligned rectangle in the cell grid.

The rectangle is anchored at its top-left corner (x, y) and extends width cells to the right and height cells down. The right and bottom edges are exclusive: a cell at (x, y) is contained iff left() <= x < right() and top() <= y < bottom().

Fields

x: u16

Column of the top-left corner.

y: u16

Row of the top-left corner.

width: u16

Width in cells.

height: u16

Height in cells.

Implementations

impl Rect

pub const ZERO: Self

An empty rectangle at the origin.

pub const fn new(x: u16, y: u16, width: u16, height: u16) -> Self

Create a rectangle from (x, y, width, height).

width and height are clamped so that right() and bottom() stay within u16.

pub const fn area(self) -> u32

Area in cells.

pub const fn is_empty(self) -> bool

True when the rectangle has zero area.

pub const fn left(self) -> u16

Inclusive left edge (column of the leftmost cell).

pub const fn right(self) -> u16

Exclusive right edge (one past the rightmost column).

pub const fn top(self) -> u16

Inclusive top edge (row of the topmost cell).

pub const fn bottom(self) -> u16

Exclusive bottom edge (one past the bottommost row).

pub const fn position(self) -> Position

The top-left corner as a Position.

pub fn contains(self, pos: impl Into<Position>) -> bool

True when pos lies inside the rectangle.

pub fn intersection(self, other: Self) -> Self

The largest rectangle contained in both self and other.

pub fn union(self, other: Self) -> Self

The smallest rectangle that contains both self and other.

Trait Implementations

impl Bounded for Rect

fn bounds(&self) -> Rect

Return the valid region in this value’s own coordinate space.

fn width(&self) -> u16

Return the width of Self::bounds in terminal cell columns.

fn height(&self) -> u16

Return the height of Self::bounds in terminal cell rows.

fn contains(&self, pos: Position) -> bool

Test whether a position lies inside Self::bounds.

impl Clone for Rect

fn clone(&self) -> Rect

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Rect

impl Debug for Rect

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

Formats the value using the given formatter.

impl Default for Rect

fn default() -> Rect

Returns the “default value” for a type.

impl Display for Rect

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

Formats the value using the given formatter.

impl Eq for Rect

impl From<(u16, u16, u16, u16)> for Rect

fn from((x, y, width, height): (u16, u16, u16, u16)) -> Self

Converts to this type from the input type.

impl From<Rect> for Position

fn from(r: Rect) -> Self

The top-left corner of the rectangle.

impl From<Rect> for (u16, u16, u16, u16)

fn from(r: Rect) -> Self

Converts to this type from the input type.

impl From<Rect> for Size

fn from(r: Rect) -> Self

The rectangle’s width by height, dropping its position.

impl Hash for Rect

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 PartialEq for Rect

fn eq(&self, other: &Rect) -> 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 StructuralPartialEq for Rect