Struct Rect 

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

A rectangular region in the terminal.

Represents a region with position (x, y) and dimensions (width, height). All coordinates use zero-based indexing.

Fields

x: u16

X coordinate (column) of the top-left corner

y: u16

Y coordinate (row) of the top-left corner

width: u16

Width in columns

height: u16

Height in rows

Implementations

impl Rect

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

Create a new rectangle.

Example

use tuxtui_core::geometry::Rect;

let rect = Rect::new(0, 0, 80, 24);
assert_eq!(rect.width, 80);
assert_eq!(rect.height, 24);

pub const fn zero() -> Self

Create a zero-sized rectangle at the origin.

pub const fn area(self) -> u32

Get the area (width × height) of the rectangle.

Example

use tuxtui_core::geometry::Rect;

let rect = Rect::new(0, 0, 10, 5);
assert_eq!(rect.area(), 50);

pub const fn is_empty(self) -> bool

Check if the rectangle is empty (zero width or height).

pub const fn left(self) -> u16

Get the left edge x coordinate.

pub const fn right(self) -> u16

Get the right edge x coordinate (exclusive).

pub const fn top(self) -> u16

Get the top edge y coordinate.

pub const fn bottom(self) -> u16

Get the bottom edge y coordinate (exclusive).

pub const fn position(self) -> Position

Get the position of the top-left corner.

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

Check if this rectangle contains a position.

Example

use tuxtui_core::geometry::{Rect, Position};

let rect = Rect::new(0, 0, 10, 10);
assert!(rect.contains(Position::new(5, 5)));
assert!(!rect.contains(Position::new(15, 5)));

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

Compute the intersection of two rectangles.

Example

use tuxtui_core::geometry::Rect;

let a = Rect::new(0, 0, 10, 10);
let b = Rect::new(5, 5, 10, 10);
let intersection = a.intersection(b);
assert_eq!(intersection, Rect::new(5, 5, 5, 5));

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

Check if this rectangle fully contains another rectangle.

Example

use tuxtui_core::geometry::Rect;

let outer = Rect::new(0, 0, 10, 10);
let inner = Rect::new(2, 2, 5, 5);
assert!(outer.contains_rect(inner));

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

Compute the union of two rectangles.

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

Apply a margin (padding) inset to the rectangle.

Example

use tuxtui_core::geometry::{Rect, Margin};

let rect = Rect::new(0, 0, 10, 10);
let inner = rect.inner(Margin::new(1, 1));
assert_eq!(inner, Rect::new(1, 1, 8, 8));

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

Clamp this rectangle to fit within another rectangle.

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

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

Formats the value using the given formatter.

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