Struct Length

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

Available on crate feature geometry only.

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

Tuple Fields

0: T

Implementations

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

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

Associate a value with a unit of measure.

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

where T: Clone,

pub fn get(self) -> T

Unpack the underlying value from the wrapper.

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

Cast the unit

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

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

Linearly interpolate between this length and another length.

Example

use euclid::default::Length;

let from = Length::new(0.0);
let to = Length::new(8.0);

assert_eq!(from.lerp(to, -1.0), Length::new(-8.0));
assert_eq!(from.lerp(to,  0.0), Length::new( 0.0));
assert_eq!(from.lerp(to,  0.5), Length::new( 4.0));
assert_eq!(from.lerp(to,  1.0), Length::new( 8.0));
assert_eq!(from.lerp(to,  2.0), Length::new(16.0));

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

where T: PartialOrd,

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

Returns minimum between this length and another length.

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

Returns maximum between this length and another length.

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

where T: NumCast + Clone,

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

where NewT: NumCast,

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

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

where NewT: NumCast,

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

Trait Implementations

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

where T: Add + Copy,

type Output = Length<<T as Add>::Output, U>

The resulting type after applying the + operator.

fn add( self, other: &Length<T, U>, ) -> <Length<T, U> as Add<&Length<T, U>>>::Output

Performs the + operation.

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

where T: Add,

type Output = Length<<T as Add>::Output, U>

The resulting type after applying the + operator.

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

Performs the + operation.

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

where T: AddAssign,

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

Performs the += operation.

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

where T: ApproxEq<T>,

fn approx_epsilon() -> T

Default epsilon value

fn approx_eq_eps(&self, other: &Length<T, U>, approx_epsilon: &T) -> bool

Returns true if this object is approximately equal to the other one, using a provided epsilon value.

fn approx_eq(&self, other: &Self) -> bool

Returns true if this object is approximately equal to the other one, using the approx_epsilon epsilon value.

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

where T: Clone,

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

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,

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

Formats the value using the given formatter.

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

where T: Default,

fn default() -> Length<T, U>

Returns the “default value” for a type.

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

where T: Div,

type Output = Scale<<T as Div>::Output, Src, Dst>

The resulting type after applying the / operator.

fn div( self, other: Length<T, Src>, ) -> <Length<T, Dst> as Div<Length<T, Src>>>::Output

Performs the / operation.

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

where T: Div,

type Output = Length<<T as Div>::Output, Src>

The resulting type after applying the / operator.

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

Performs the / operation.

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

where T: Div,

type Output = Length<<T as Div>::Output, U>

The resulting type after applying the / operator.

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

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

where T: Hash,

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

where H: Hasher,

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<Src, Dst, T> Mul<Scale<T, Src, Dst>> for Length<T, Src>

where T: Mul,

type Output = Length<<T as Mul>::Output, Dst>

The resulting type after applying the * operator.

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

Performs the * operation.

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

where T: Mul,

type Output = Length<<T as Mul>::Output, U>

The resulting type after applying the * operator.

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

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: Neg,

type Output = Length<<T as Neg>::Output, U>

The resulting type after applying the - operator.

fn neg(self) -> <Length<T, U> as Neg>::Output

Performs the unary - operation.

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

where T: Ord,

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

where T: PartialEq,

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

where T: PartialOrd,

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

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

where T: Sub,

type Output = Length<<T as Sub>::Output, 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<T, U> SubAssign for Length<T, U>

where T: SubAssign,

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

Performs the -= operation.

impl<'a, T, U> Sum<&'a Length<T, U>> for Length<T, U>

where T: 'a + Add<Output = T> + Copy + Zero, U: 'a,

fn sum<I>(iter: I) -> Length<T, U>

where I: Iterator<Item = &'a Length<T, U>>,

Takes an iterator and generates Self from the elements by “summing up” the items.

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

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

fn sum<I>(iter: I) -> Length<T, U>

where I: Iterator<Item = Length<T, U>>,

Takes an iterator and generates Self from the elements by “summing up” the items.

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

where T: Zero,

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

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

where T: Copy,

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

where T: Eq,