Struct nines::ValidDimensions

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

Slice dimensions with non-negative & non-NAN dimensions (including borders.)

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

Methods

impl<S: Scalar> ValidDimensions<S>

#[must_use] pub fn outer(&self) -> ValidRect<S>

#[must_use] pub fn inner(&self) -> ValidRect<S>

#[must_use] pub fn borders(&self) -> Rect<S>

Get the sizes of the borders - that is, the spacing between the outer and inner rects.

 left   right
 ┊←→┊    ┊←→┊
 ┊  ┊    ┊  ┊
 ┌──┬────┬──┐┈┈
 │  │    │  │ ↕ top
 ├──┼────┼──┤┈┈
 │  │    │  │
 │  │    │  │
 ├──┼────┼──┤┈┈
 │  │    │  │ ↕ bottom
 └──┴────┴──┘┈┈

#[must_use] pub fn with_outer(&self, outer: impl Into<ValidRect<S>>) -> Result<Self, Error>

Create a new 9-slice with specified outer dimensions, keeping the border sizes the same.

Can return Err if:

• rect is invalid
• The center would have negative bounds

May panic on overflow/underflow.

#[must_use] pub fn with_inner(&self, inner: impl Into<ValidRect<S>>) -> Self

Create a new 9-slice with specified inner dimensions, keeping the border sizes the same.

May panic on overflow/underflow.

Methods from Deref<Target = Dimensions<S>>

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

Validate these dimensions are non-negative / non-NaN. This means:

outer.left ≤ inner.left ≤ inner.right ≤ outer.right
outer.top ≤ inner.top ≤ inner.bottom ≤ outer.bottom

Trait Implementations

impl<S: Clone + Scalar> Clone for ValidDimensions<S>

fn clone(&self) -> ValidDimensions<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 ValidDimensions<S>

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

fn default() -> ValidDimensions<S>

Returns the "default value" for a type.

impl<S: Scalar> PartialEq<ValidDimensions<S>> for ValidDimensions<S>

fn eq(&self, other: &ValidDimensions<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<Dimensions<S>> for ValidDimensions<S>

fn eq(&self, other: &Dimensions<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<ValidDimensions<S>> for Dimensions<S>

fn eq(&self, other: &ValidDimensions<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 ValidDimensions<S>

type Target = Dimensions<S>

The resulting type after dereferencing.

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

Dereferences the value.

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

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

Formats the value using the given formatter.

impl<S: Scalar> TryFrom<Dimensions<S>> for ValidDimensions<S>

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<'_, S: Scalar> TryFrom<&'_ Dimensions<S>> for ValidDimensions<S>

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.