Struct nines::Dimensions

pub struct Dimensions<S: Scalar> {
    pub outer: Rect<S>,
    pub inner: Rect<S>,
}

The dimensions of a nine-square layout. See also ValidDimensions.

left             right   ┌──→ +x
 ┊←──── outer ────→┊     │
 ┊                 ┊     ↓
 ┊  ┊←─ inner ─→┊  ┊    + y
 ┊  ┊           ┊  ┊
 ┌──┬───────────┬──┐┈┈┈┈┈┈┈┈ top
 │  │           │  │          ↑
 ├──┼───────────┼──┤┈┈┈┈      │
 │  │           │  │   ↑      │
 │  │           │  │ inner  outer
 │  │           │  │   ↓      │
 ├──┼───────────┼──┤┈┈┈┈      │
 │  │           │  │          ↓
 └──┴───────────┴──┘┈┈┈┈┈┈ bottom

Fields

outer: Rect<S>

inner: Rect<S>

Methods

impl<S: Scalar> 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 Dimensions<S>

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

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

fn default() -> Dimensions<S>

Returns the "default value" for a type.

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: PartialEq + Scalar> PartialEq<Dimensions<S>> for Dimensions<S>

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

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

fn ne(&self, other: &Dimensions<S>) -> bool

This method tests for !=.

impl<S: Debug + Scalar> Debug for Dimensions<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.

impl<S: Scalar> StructuralPartialEq for Dimensions<S>