Struct euclid::Length

#[repr(C)]pub struct Length<T, Unit>(pub T, _);

A one-dimensional distance, with value represented by T and unit of measurement Unit.

T can be any numeric type, for example a primitive type like u64 or f32.

Unit is not used in the representation of a Length value. It is used only at compile time to ensure that a Length stored with one unit is converted explicitly before being used in an expression that requires a different unit. It may be a type without values, such as an empty enum.

You can multiply a Length by a scale::Scale to convert it from one unit to another. See the Scale docs for an example.

Methods

impl<T, U> Length<T, U>

pub const fn new(x: T) -> Self

impl<T: Clone, U> Length<T, U>

pub fn get(&self) -> T

pub fn cast_unit<V>(&self) -> Length<T, V>

Cast the unit

impl<T: NumCast + Clone, U> Length<T, U>

pub fn cast<NewT: NumCast>(&self) -> Length<NewT, U>

Cast from one numeric representation to another, preserving the units.

pub fn try_cast<NewT: NumCast>(&self) -> Option<Length<NewT, U>>

Fallible cast from one numeric representation to another, preserving the units.

impl<T, U> Length<T, U> where
    T: Copy + One + Add<Output = T> + Sub<Output = T> + Mul<Output = T>, 

pub fn lerp(&self, other: Self, t: T) -> Self

Linearly interpolate between this length and another length.

When t is One::one(), returned value equals to other, otherwise equals to self.

Trait Implementations

impl<U, T: Add<T, Output = T>> Add<Length<T, U>> for Length<T, U>

type Output = Length<T, U>

The resulting type after applying the + operator.

fn add(self, other: Length<T, U>) -> Length<T, U>

Performs the + operation.

impl<U, T: AddAssign<T>> AddAssign<Length<T, U>> for Length<T, U>

fn add_assign(&mut self, other: Length<T, U>)

Performs the += operation.

impl<T: Clone, U> Clone for Length<T, U>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Copy, U> Copy for Length<T, U>

impl<T: Debug, U> Debug for Length<T, U>

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

Formats the value using the given formatter.

impl<T: Default, U> Default for Length<T, U>

fn default() -> Self

Returns the "default value" for a type.

impl<T: Display, U> Display for Length<T, U>

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

Formats the value using the given formatter.

impl<Src, Dst, T: Div<T, Output = T>> Div<Length<T, Src>> for Length<T, Dst>

type Output = Scale<T, Src, Dst>

The resulting type after applying the / operator.

fn div(self, other: Length<T, Src>) -> Scale<T, Src, Dst>

Performs the / operation.

impl<Src, Dst, T: Div<T, Output = T>> Div<Scale<T, Src, Dst>> for Length<T, Dst>

type Output = Length<T, Src>

The resulting type after applying the / operator.

fn div(self, scale: Scale<T, Src, Dst>) -> Length<T, Src>

Performs the / operation.

impl<T: Div<T, Output = T>, U> Div<T> for Length<T, U>

type Output = Self

The resulting type after applying the / operator.

fn div(self, scale: T) -> Self

Performs the / operation.

impl<T: Copy + Div<T, Output = T>, U> DivAssign<T> for Length<T, U>

fn div_assign(&mut self, scale: T)

Performs the /= operation.

impl<T: Eq, U> Eq for Length<T, U>

impl<T, U> Hash for Length<T, U> where
    T: Hash, 

fn hash<H: Hasher>(&self, h: &mut H)

Feeds this value into the given [Hasher].

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

Feeds a slice of this type into the given [Hasher].

impl<Src, Dst, T: Mul<T, Output = T>> Mul<Scale<T, Src, Dst>> for Length<T, Src>

type Output = Length<T, Dst>

The resulting type after applying the * operator.

fn mul(self, scale: Scale<T, Src, Dst>) -> Length<T, Dst>

Performs the * operation.

impl<T: Mul<T, Output = T>, U> Mul<T> for Length<T, U>

type Output = Self

The resulting type after applying the * operator.

fn mul(self, scale: T) -> Self

Performs the * operation.

impl<T: Copy + Mul<T, Output = T>, U> MulAssign<T> for Length<T, U>

fn mul_assign(&mut self, scale: T)

Performs the *= operation.

impl<U, T: Neg<Output = T>> Neg for Length<T, U>

type Output = Length<T, U>

The resulting type after applying the - operator.

fn neg(self) -> Length<T, U>

Performs the unary - operation.

impl<T: Ord, U> Ord for Length<T, U>

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

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<T: PartialEq, U> PartialEq<Length<T, U>> for Length<T, U>

fn eq(&self, other: &Self) -> 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<T: PartialOrd, U> PartialOrd<Length<T, U>> for Length<T, U>

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

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

#[must_use]fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]fn le(&self, other: &Rhs) -> bool

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

#[must_use]fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]fn ge(&self, other: &Rhs) -> bool

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

impl<U, T: Saturating> Saturating for Length<T, U>

fn saturating_add(self, other: Length<T, U>) -> Length<T, U>

Saturating addition operator. Returns a+b, saturating at the numeric bounds instead of overflowing.

fn saturating_sub(self, other: Length<T, U>) -> Length<T, U>

Saturating subtraction operator. Returns a-b, saturating at the numeric bounds instead of overflowing.

impl<U, T: Sub<T, Output = T>> Sub<Length<T, U>> for Length<T, U>

type Output = Length<T, U>

The resulting type after applying the - operator.

fn sub(self, other: Length<T, U>) -> Self::Output

Performs the - operation.

impl<U, T: SubAssign<T>> SubAssign<Length<T, U>> for Length<T, U>

fn sub_assign(&mut self, other: Length<T, U>)

Performs the -= operation.

impl<T: Zero, U> Zero for Length<T, U>

fn zero() -> Self