Struct nines::Rect

pub struct Rect<V: Debug> {
    pub left: V,
    pub right: V,
    pub top: V,
    pub bottom: V,
}

A rectangle. See also ValidRect. Generally not inclusive of the right/bottom edge.

Fields

left: V

right: V

top: V

bottom: V

Methods

impl<S: Scalar> Rect<S>

#[must_use] pub fn xywh(x: S, y: S, w: S, h: S) -> Self

#[must_use] pub fn grow(&self, borders: &Self) -> Self

#[must_use] pub fn shrink(&self, borders: &Self) -> Self

#[must_use] pub fn validate(&self) -> Result<ValidRect<S>, Error>

Validate this rectangle has non-negative / non-NaN dimensions. This means:

left ≤ right
top ≤ bottom

Trait Implementations

impl<S: Scalar> From<Range<[S; 2]>> for Rect<S>

fn from(value: Range<[S; 2]>) -> Self

Performs the conversion.

impl<S: Scalar> From<[Range<S>; 2]> for Rect<S>

fn from(value: [Range<S>; 2]) -> Self

Performs the conversion.

impl<S: Scalar> From<Range<(S, S)>> for Rect<S>

fn from(value: Range<(S, S)>) -> Self

Performs the conversion.

impl<S: Scalar> From<(Range<S>, Range<S>)> for Rect<S>

fn from(value: (Range<S>, Range<S>)) -> Self

Performs the conversion.

impl<V: Clone + Debug> Clone for Rect<V>

fn clone(&self) -> Rect<V>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<V: Copy + Debug> Copy for Rect<V>

impl<V: Default + Debug> Default for Rect<V>

fn default() -> Rect<V>

Returns the "default value" for a type.

impl<S: Scalar> PartialEq<Rect<S>> for ValidRect<S>

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<S: Scalar> PartialEq<ValidRect<S>> for Rect<S>

fn eq(&self, other: &ValidRect<S>) -> bool

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<V: PartialEq + Debug> PartialEq<Rect<V>> for Rect<V>

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

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

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

This method tests for !=.

impl<V: Debug> Debug for Rect<V>

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

Formats the value using the given formatter.

impl<S: Scalar> TryFrom<Rect<S>> for ValidRect<S>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Rect<S>) -> Result<Self, Error>

Performs the conversion.

impl<'_, S: Scalar> TryFrom<&'_ Rect<S>> for ValidRect<S>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &Rect<S>) -> Result<Self, Error>

Performs the conversion.

impl<V: Debug> StructuralPartialEq for Rect<V>