Struct Rect 

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

A rectangular area in terminal coordinates.

All positions are zero-indexed. The top-left of the terminal is (0, 0).

Fields

x: u16

y: u16

width: u16

height: u16

Implementations

impl Rect

pub const ZERO: Rect

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

pub const fn area(&self) -> u32

Total number of cells in this rectangle.

pub const fn is_empty(&self) -> bool

Whether this rectangle has zero area.

pub const fn left(&self) -> u16

The leftmost column.

pub const fn right(&self) -> u16

The rightmost column (exclusive).

pub const fn top(&self) -> u16

The topmost row.

pub const fn bottom(&self) -> u16

The bottommost row (exclusive).

pub const fn center(&self) -> Position

The center position.

pub fn intersection(&self, other: Rect) -> Rect

Returns the intersection of two rectangles.

pub fn union(&self, other: Rect) -> Rect

Returns the smallest rectangle that contains both.

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

Whether this rectangle contains a position.

pub fn inner(&self, margin: Margin) -> Rect

Create a new rect with uniform inner margin applied.

pub fn positions(&self) -> impl Iterator<Item = Position> + '_

Iterator over all positions in this rectangle, row by row.

pub fn rows(&self) -> impl Iterator<Item = u16>

Iterator over row indices.

pub fn columns(&self) -> impl Iterator<Item = u16>

Iterator over column indices.

Trait Implementations

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 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<'de> Deserialize<'de> for Rect

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Rect> for Size

fn from(rect: Rect) -> 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 Serialize for Rect

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for Rect

impl Eq for Rect

impl StructuralPartialEq for Rect