Struct Distance 

#[repr(transparent)]
pub struct Distance<T, const D: usize> {
    pub dim: [T; D],
}

📐 A separation between two locations in D-dimensional space.

---

^{📍 geom/metric}

---

Represents a displacement vector without an absolute origin. It describes the magnitude of separation between positions.

• Unlike Position, Distance is relative, and represents how far apart two positions are.
• Unlike Orientation, Distance has magnitude but no defined direction.

See also: Distance1, Distance2, Distance3, dis!.

Fields

dim: [T; D]

The component-wise separation in D-dimensional space.

Implementations

impl<T, const D: usize> Distance<T, D>

pub const fn new(dimensions: [T; D]) -> Self

Constructs a new Distance from the given dimensions.

pub const fn as_slice(&self) -> &[T]

Returns a shared reference to the distance as a slice.

pub const fn as_slice_mut(&mut self) -> &mut [T]

Returns an exclusive reference to the distance as a slice.

pub fn is_uniform_nd(&self) -> bool

where T: PartialEq,

Returns true if all dimensions of the extent are equal. Returns true if all dimensions of the distance are equal.

pub fn map<U>(self, f: impl FnMut(T) -> U) -> Distance<U, D>

Returns a new Distance by applying f to each dimension.

This is a runtime, dimension-preserving transformation.

It is useful for reshaping the inner scalar type without introducing blanket From/TryFrom impl conflicts on the wrapper itself.

pub fn try_map<U, E>( self, f: impl FnMut(T) -> Result<U, E>, ) -> Result<Distance<U, D>, E>

Returns a new Distance by fallibly applying f to each dimension.

Stops at the first conversion error and returns it.

This is the fallible counterpart to map, and is the recommended runtime path for per-dimension checked conversion.

pub fn map_into<U>(self) -> Distance<U, D>

where U: From<T>,

Converts this distance to another inner type U when U implements From<T>.

This is a convenience wrapper over map.

pub fn try_map_into<E, U>(self) -> Result<Distance<U, D>, E>

where U: TryFrom<T, Error = E>,

Tries to convert this distance to another inner type U when U implements TryFrom<T>.

This is a convenience wrapper over try_map.

impl<T> Distance<T, 2>

pub const fn x(self) -> T

where T: Copy,

Returns a copy of the first dimension x.

pub const fn y(self) -> T

where T: Copy,

Returns a copy of the second dimension y.

pub fn is_uniform(&self) -> bool

where T: PartialEq,

Returns true if the 2 dimensions are equal.

impl<T> Distance<T, 3>

pub const fn x(self) -> T

where T: Copy,

Returns a copy of the first dimension x.

pub const fn y(self) -> T

where T: Copy,

Returns a copy of the second dimension y.

pub const fn z(self) -> T

where T: Copy,

Returns a copy of the third dimension z.

pub fn is_uniform_3d(&self) -> bool

where T: PartialEq,

Returns true if the 3 dimensions are equal.

Trait Implementations

impl<T: Clone, const D: usize> Clone for Distance<T, D>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: ConstInit, const D: usize> ConstInit for Distance<T, D>

const INIT: Self

Returns the compile-time “initial value” for a type.

impl<T: Copy, const D: usize> Copy for Distance<T, D>

impl<T: Debug, const D: usize> Debug for Distance<T, D>

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

Formats the value using the given formatter.

impl<T: Default, const D: usize> Default for Distance<T, D>

fn default() -> Self

Returns the “default value” for a type.

impl<T: Display, const D: usize> Display for Distance<T, D>

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

Formats the value using the given formatter.

impl<T: Eq, const D: usize> Eq for Distance<T, D>

impl<T> From<(T, T)> for Distance<T, 2>

fn from(dim: (T, T)) -> Self

Converts to this type from the input type.

impl<T> From<(T, T, T)> for Distance<T, 3>

fn from(dim: (T, T, T)) -> Self

Converts to this type from the input type.

impl<T> From<(T, T, T, T)> for Distance<T, 4>

fn from(dim: (T, T, T, T)) -> Self

Converts to this type from the input type.

impl<T, const D: usize> From<[T; D]> for Distance<T, D>

fn from(dim: [T; D]) -> Self

Converts to this type from the input type.

impl<T: Hash, const D: usize> Hash for Distance<T, D>

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

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<T: Ord, const D: usize> Ord for Distance<T, D>

fn cmp(&self, other: &Self) -> 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<T: PartialEq, const D: usize> PartialEq for Distance<T, D>

fn eq(&self, other: &Self) -> 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<T: PartialOrd, const D: usize> PartialOrd for Distance<T, D>

fn partial_cmp(&self, other: &Self) -> 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.