Struct Rect 

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

A rectangle for scissor regions, layout bounds, and hit testing.

Uses terminal coordinates (0-indexed, origin at top-left).

Fields

x: u16

Left edge (inclusive).

y: u16

Top edge (inclusive).

width: u16

Width in cells.

height: u16

Height in cells.

Implementations

impl Rect

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

Create a new rectangle.

pub const fn from_size(width: u16, height: u16) -> Self

Create a rectangle from origin with given size.

pub const fn left(&self) -> u16

Left edge (inclusive). Alias for self.x.

pub const fn top(&self) -> u16

Top edge (inclusive). Alias for self.y.

pub const fn right(&self) -> u16

Right edge (exclusive).

pub const fn bottom(&self) -> u16

Bottom edge (exclusive).

pub const fn area(&self) -> u32

Area in cells.

pub const fn is_empty(&self) -> bool

Check if the rectangle has zero area.

pub const fn contains(&self, x: u16, y: u16) -> bool

Check if a point is inside the rectangle.

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

Compute the intersection with another rectangle.

Returns an empty rectangle if the rectangles don’t overlap.

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

Create a new rectangle inside the current one with the given margin.

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

Create a new rectangle that is the union of this rectangle and another.

The result is the smallest rectangle that contains both.

Note: a rectangle’s position participates even when it is empty — Rect::new(100, 100, 0, 0).union(&r) extends to x/y 100. When accumulating a union over a collection, seed the fold with the first element rather than Rect::default() (which would pin the result to the origin).

pub fn intersection_opt(&self, other: &Rect) -> Option<Rect>

Compute the intersection with another rectangle, returning None if no overlap.

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

impl From<Rect> for Size

fn from(rect: Rect) -> Self

Converts to this type from the input type.

impl PartialEq for Rect

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Rect