Struct Dimension 

pub struct Dimension(/* private fields */);

A positive spatial dimension count.

Implementations

impl Dimension

pub const ONE: Self

One-dimensional space.

pub const TWO: Self

Two-dimensional space.

pub const THREE: Self

Three-dimensional space.

pub const fn new(value: usize) -> Option<Self>

Creates a positive dimension count.

pub const fn new_unchecked(value: usize) -> Self

Creates a dimension count without checking whether it is positive.

pub const fn value(self) -> usize

Returns the numeric dimension count.

pub const fn is_spatial(self) -> bool

Returns true for dimensions commonly used as spatial geometry.

Trait Implementations

impl Clone for Dimension

fn clone(&self) -> Dimension

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Dimension

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

Formats the value using the given formatter.

impl Hash for Dimension

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Dimension

fn cmp(&self, other: &Dimension) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Dimension

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Dimension

fn partial_cmp(&self, other: &Dimension) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for Dimension

impl Eq for Dimension

impl StructuralPartialEq for Dimension