Struct 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::TypedScale to convert it from one unit to another. See the TypedScale docs for an example.

Tuple Fields

0: T

Implementations

impl<T, Unit> Length<T, Unit>

pub fn new(x: T) -> Length<T, Unit>

impl<Unit, T> Length<T, Unit>

where T: Clone,

pub fn get(&self) -> T

impl<Unit, T0> Length<T0, Unit>

where T0: NumCast + Clone,

pub fn cast<T1>(&self) -> Length<T1, Unit>

where T1: NumCast + Clone,

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

pub fn try_cast<T1>(&self) -> Option<Length<T1, Unit>>

where T1: NumCast + Clone,

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

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

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

pub fn lerp(&self, other: Length<T, U>, t: T) -> Length<T, U>

Linearly interpolate between this length and another length.

t is expected to be between zero and one.

Trait Implementations

impl<U, T> Add for Length<T, U>

where T: Clone + Add<Output = T>,

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 for Length<T, U>

where T: Clone + AddAssign,

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

Performs the += operation.

impl<T, Unit> Clone for Length<T, Unit>

where T: Clone,

fn clone(&self) -> Length<T, Unit>

Returns a copy of the value.

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

Performs copy-assignment from source.

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

where T: Debug + Clone,

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

Formats the value using the given formatter.

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

where T: Display + Clone,

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

Formats the value using the given formatter.

impl<Src, Dst, T> Div<Length<T, Src>> for Length<T, Dst>

where T: Clone + Div<Output = T>,

type Output = TypedScale<T, Src, Dst>

The resulting type after applying the / operator.

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

Performs the / operation.

impl<T, U> Div<T> for Length<T, U>

where T: Copy + Div<Output = T>,

type Output = Length<T, U>

The resulting type after applying the / operator.

fn div(self, scale: T) -> Length<T, U>

Performs the / operation.

impl<Src, Dst, T> Div<TypedScale<T, Src, Dst>> for Length<T, Dst>

where T: Clone + Div<Output = T>,

type Output = Length<T, Src>

The resulting type after applying the / operator.

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

Performs the / operation.

impl<T, U> DivAssign<T> for Length<T, U>

where T: Copy + Div<Output = T>,

fn div_assign(&mut self, scale: T)

Performs the /= operation.

impl<T, U> Mul<T> for Length<T, U>

where T: Copy + Mul<Output = T>,

type Output = Length<T, U>

The resulting type after applying the * operator.

fn mul(self, scale: T) -> Length<T, U>

Performs the * operation.

impl<Src, Dst, T> Mul<TypedScale<T, Src, Dst>> for Length<T, Src>

where T: Clone + Mul<Output = T>,

type Output = Length<T, Dst>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<T, U> MulAssign<T> for Length<T, U>

where T: Copy + Mul<Output = T>,

fn mul_assign(&mut self, scale: T)

Performs the *= operation.

impl<U, T> Neg for Length<T, U>

where T: Clone + Neg<Output = T>,

type Output = Length<T, U>

The resulting type after applying the - operator.

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

Performs the unary - operation.

impl<Unit, T> Ord for Length<T, Unit>

where T: Clone + Ord,

fn cmp(&self, other: &Length<T, Unit>) -> 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<Unit, T> PartialEq for Length<T, Unit>

where T: Clone + PartialEq,

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

where T: Clone + PartialOrd,

fn partial_cmp(&self, other: &Length<T, Unit>) -> 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<U, T> Saturating for Length<T, U>

where T: Clone + Saturating,

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 for Length<T, U>

where T: Clone + Sub<Output = T>,

type Output = Length<T, U>

The resulting type after applying the - operator.

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

Performs the - operation.

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

where T: Clone + SubAssign,

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

Performs the -= operation.

impl<Unit, T> Zero for Length<T, Unit>

where T: Zero,

fn zero() -> Length<T, Unit>

impl<T, Unit> Copy for Length<T, Unit>

where T: Copy,

impl<Unit, T> Eq for Length<T, Unit>

where T: Clone + Eq,