Struct Rect 

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

A rectangular area in the terminal.

Fields

x: u16

Column of the top-left corner.

y: u16

Row of the top-left corner.

width: u16

Width in columns.

height: u16

Height in rows.

Implementations

impl Rect

pub const MAX: Self

A rect that covers the entire addressable terminal area.

pub const MIN: Self = Self::ZERO

The smallest possible rect (same as ZERO).

pub const ZERO: Self

A zero-width, zero-height rect at the origin.

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

Create a new rect, clamping width/height so the rect does not overflow u16.

pub const fn area(self) -> u32

Total number of cells inside this rect.

pub const fn is_empty(self) -> bool

Returns true if the rect has zero width or height.

pub const fn left(self) -> u16

The leftmost column (same as x).

pub const fn right(self) -> u16

The first column after the right edge (x + width).

pub const fn top(self) -> u16

The topmost row (same as y).

pub const fn bottom(self) -> u16

The first row after the bottom edge (y + height).

pub const fn row(self) -> u16

The row of the top edge (same as y).

pub const fn col(self) -> u16

The column of the left edge (same as x).

pub const fn inner(self, margin: Margin) -> Self

Shrink this rect by the given margin on all sides.

pub const fn outer(self, margin: Margin) -> Self

Expand this rect by the given margin on all sides.

pub fn offset(self, offset: Offset) -> Self

Move this rect by the given offset, clamping to the valid u16 range.

pub const fn resize(self, size: Size) -> Self

Resize this rect to the given dimensions, keeping the top-left corner.

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

The smallest rect that contains both self and other.

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

The overlap between self and other.

Returns a zero-area rect if they do not intersect.

pub const fn intersects(self, other: Self) -> bool

Returns true if self and other overlap.

pub const fn contains(self, position: Position) -> bool

Returns true if the given position lies inside this rect.

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

Clamp this rect so it fits entirely inside other.

pub const fn rows(self) -> Rows

Iterate over each row in this rect as a 1-cell-high Rect.

pub const fn columns(self) -> Columns

Iterate over each column in this rect as a 1-cell-wide Rect.

pub const fn positions(self) -> Positions

Iterate over every cell position in this rect.

pub const fn as_position(self) -> Position

Return the top-left corner as a Position.

pub const fn as_size(self) -> Size

Return the dimensions as a Size.

Trait Implementations

impl Add<Offset> for Rect

type Output = Rect

The resulting type after applying the + operator.

fn add(self, offset: Offset) -> Self::Output

Performs the + operation.

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<(Position, Size)> for Rect

fn from((position, size): (Position, Size)) -> Self

Converts to this type from the input type.

impl From<Rect> for Position

fn from(rect: Rect) -> Self

Converts to this type from the input type.

impl From<Size> for Rect

fn from(size: Size) -> Self

Converts to this type from the input type.

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

impl Sub<Offset> for Rect

type Output = Rect

The resulting type after applying the - operator.

fn sub(self, offset: Offset) -> Self::Output

Performs the - operation.