Struct cursive::Rect

pub struct Rect { /* fields omitted */ }

A non-empty rectangle on the 2D grid.

Implementations

impl Rect

pub fn from_size<U, V>(top_left: U, size: V) -> Rect where
    U: Into<XY<usize>>,
    V: Into<XY<usize>>, 

Creates a new Rect with the given position and size.

The minimum size will (1, 1).

pub fn from_corners<U, V>(a: U, b: V) -> Rect where
    U: Into<XY<usize>>,
    V: Into<XY<usize>>, 

Creates a new Rect from two corners.

It can be any two opposite corners.

pub fn expand_to<R>(&mut self, other: R) where
    R: Into<Rect>, 

Grow this rectangle if necessary to include other.

pub fn expanded_to<R>(self, other: R) -> Rect where
    R: Into<Rect>, 

Returns a new rectangle that includes both self and other.

pub fn side(self, orientation: Orientation) -> (usize, usize)

Returns the start and end coordinate of one side of this rectangle.

Both start and end are inclusive.

pub fn edge(self, side: Absolute) -> usize

Returns the coordinate of the given edge.

All edges are inclusive.

pub fn offset<V>(&mut self, offset: V) where
    V: Into<XY<usize>>, 

Adds the given offset to this rectangle.

pub fn size(self) -> XY<usize>

Returns the size of the rectangle.

pub fn width(self) -> usize

Returns the width of the rectangle.

pub fn height(self) -> usize

Returns the height of the rectangle.

pub fn top_left(self) -> XY<usize>

Returns the top-left corner.

This is inclusive.

pub fn bottom_right(self) -> XY<usize>

Returns the bottom-right corner.

This is inclusive.

pub fn top_right(self) -> XY<usize>

Returns the top-right corner.

This is inclusive.

pub fn bottom_left(self) -> XY<usize>

Returns the bottom-left corner.

This is inclusive.

pub fn top(self) -> usize

Returns the Y value of the top edge of the rectangle.

This is inclusive.

pub fn left(self) -> usize

Returns the X value of the left edge of the rectangle.

This is inclusive.

pub fn right(self) -> usize

Returns the X value of the right edge of the rectangle.

This is inclusive.

pub fn bottom(self) -> usize

Returns the Y value of the botton edge of the rectangle.

This is inclusive.

pub fn surface(self) -> usize

Returns the surface (number of cells) covered by the rectangle.

pub fn contains(self, point: XY<usize>) -> bool

Checks if a point is in self.

Trait Implementations

impl<T> Add<T> for Rect where
    T: Into<XY<usize>>, 

type Output = Rect

The resulting type after applying the + operator.

pub fn add(self, rhs: T) -> Rect

Performs the + operation.

impl Clone for Rect

pub fn clone(&self) -> Rect

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Rect

impl Debug for Rect

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

Formats the value using the given formatter.

impl Eq for Rect

impl<T> From<T> for Rect where
    T: Into<XY<usize>>, 

pub fn from(other: T) -> Rect

Performs the conversion.

impl Hash for Rect

pub fn hash<__H>(&self, state: &mut __H) where
    __H: Hasher, 

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<Rect> for Rect

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralEq for Rect

impl StructuralPartialEq for Rect