Struct nines::ValidRect

pub struct ValidRect<S: Scalar>(_);

A rectangle with non-negative & non-NAN dimensions.

Do not base soundness assumptions on this definition of validity - debug_assert_valid can bypass checks.

Methods

impl<S: Scalar> ValidRect<S>

#[must_use] pub fn width(&self) -> S

#[must_use] pub fn height(&self) -> S

#[must_use] pub fn size(&self) -> [S; 2]

Methods from Deref<Target = Rect<S>>

#[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: Clone + Scalar> Clone for ValidRect<S>

fn clone(&self) -> ValidRect<S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S: Copy + Scalar> Copy for ValidRect<S>

impl<S: Default + Scalar> Default for ValidRect<S>

fn default() -> ValidRect<S>

Returns the "default value" for a type.

impl<S: Scalar> PartialEq<ValidRect<S>> for ValidRect<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<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<S: Scalar> Deref for ValidRect<S>

type Target = Rect<S>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<S: Debug + Scalar> Debug for ValidRect<S>

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.