Struct ZRect

pub struct ZRect {
    pub x: u16,
    pub y: u16,
    pub z: u16,
    pub width: u16,
    pub height: u16,
}

Extension of Rect.

Adds a z value for stacking overlaying areas.

This is useful when handling mouse events for widgets with overlays/popups.

Fields

x: u16

Coordinates

y: u16

z: u16

width: u16

height: u16

Implementations

impl ZRect

pub const ZERO: Self = _

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

pub const fn as_rect(self) -> Rect

pub const fn is_empty(self) -> bool

Returns true if the Rect has no area.

pub const fn left(self) -> u16

Returns the left coordinate of the Rect.

pub const fn right(self) -> u16

Returns the right coordinate of the Rect. This is the first coordinate outside of the Rect.

If the right coordinate is larger than the maximum value of u16, it will be clamped to u16::MAX.

pub const fn top(self) -> u16

Returns the top coordinate of the Rect.

pub const fn bottom(self) -> u16

Returns the bottom coordinate of the Rect. This is the first coordinate outside of the Rect.

If the bottom coordinate is larger than the maximum value of u16, it will be clamped to u16::MAX.

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

Returns a new Rect inside the current one, with the given margin on each side.

If the margin is larger than the Rect, the returned Rect will have no area.

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

Moves the Rect without modifying its size.

Moves the Rect according to the given offset without modifying its width or height.

• Positive x moves the whole Rect to the right, negative to the left.
• Positive y moves the whole Rect to the bottom, negative to the top.

See Offset for details.

pub fn union_all(areas: &[ZRect]) -> Option<ZRect>

Apply union to all rects.

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

Returns a new Rect that contains both the current one and the given one. The z-value is set to max(self.z, other.z).

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

Returns true if the given position is inside the Rect.

The position is considered inside the Rect if it is on the Rect’s border.

Examples

let rect = Rect::new(1, 2, 3, 4);
assert!(rect.contains(Position { x: 1, y: 2 }));

pub const fn rows(self) -> Rows

An iterator over rows within the Rect.

Example

fn render(area: Rect, buf: &mut Buffer) {
    for row in area.rows() {
        Line::raw("Hello, world!").render(row, buf);
    }
}

pub const fn columns(self) -> Columns

An iterator over columns within the Rect.

Example

fn render(area: Rect, buf: &mut Buffer) {
    if let Some(left) = area.columns().next() {
        Block::new().borders(Borders::LEFT).render(left, buf);
    }
}

pub const fn positions(self) -> Positions

An iterator over the positions within the Rect.

The positions are returned in a row-major order (left-to-right, top-to-bottom).

Example

fn render(area: Rect, buf: &mut Buffer) {
    for position in area.positions() {
        buf.get_mut(position.x, position.y).set_symbol("x");
    }
}

pub const fn as_position(self) -> Position

Returns a Position with the same coordinates as this Rect.

Examples

let rect = Rect::new(1, 2, 3, 4);
let position = rect.as_position();

pub const fn as_size(self) -> Size

Converts the Rect into a size struct.

Trait Implementations

impl Clone for ZRect

fn clone(&self) -> ZRect

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ZRect

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

Formats the value using the given formatter.

impl Default for ZRect

fn default() -> ZRect

Returns the “default value” for a type.

impl From<(Position, Size)> for ZRect

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

Converts to this type from the input type.

impl From<(u16, Rect)> for ZRect

fn from(plane_rect: (u16, Rect)) -> Self

Converts to this type from the input type.

impl From<Rect> for ZRect

fn from(base_plane: Rect) -> Self

Converts to this type from the input type.

impl Hash for ZRect

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 ZRect

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

impl Eq for ZRect

impl StructuralPartialEq for ZRect