Struct euclid::length::Length

pub struct Length<Unit, T>(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_factor::ScaleFactor to convert it from one unit to another. See the ScaleFactor docs for an example.

Methods

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

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

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

fn get(&self) -> T

impl<Unit, T0: NumCast + Clone> Length<Unit, T0>

fn cast<T1: NumCast + Clone>(&self) -> Option<Length<Unit, T1>>

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

Trait Implementations

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

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

Formats the value using the given formatter.

impl<Unit: Encodable, T: Encodable> Encodable for Length<Unit, T>

fn encode<__SUnitT: Encoder>(&self, __arg_0: &mut __SUnitT) -> Result<(), __SUnitT::Error>

impl<Unit: Decodable, T: Decodable> Decodable for Length<Unit, T>

fn decode<__DUnitT: Decoder>(__arg_0: &mut __DUnitT) -> Result<Length<Unit, T>, __DUnitT::Error>

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

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

type Output = Length<U, T>

The resulting type after applying the + operator

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

The method for the + operator

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

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

The method for the += operator

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

type Output = Length<U, T>

The resulting type after applying the - operator

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

The method for the - operator

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

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

The method for the -= operator

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

type Output = ScaleFactor<Src, Dst, T>

The resulting type after applying the / operator

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

The method for the / operator

impl<Src, Dst, T: Clone + Mul<T, Output=T>> Mul<ScaleFactor<Src, Dst, T>> for Length<Src, T>

type Output = Length<Dst, T>

The resulting type after applying the * operator

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

The method for the * operator

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

type Output = Length<Src, T>

The resulting type after applying the / operator

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

The method for the / operator

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

type Output = Length<U, T>

The resulting type after applying the - operator

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

The method for the unary - operator

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Unit, T: Clone + PartialEq> PartialEq for Length<Unit, T>

fn eq(&self, other: &Length<Unit, T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl<Unit, T: Clone + PartialOrd> PartialOrd for Length<Unit, T>

fn partial_cmp(&self, other: &Length<Unit, T>) -> Option<Ordering>

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

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

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

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

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

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

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

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<Unit, T: Clone + Eq> Eq for Length<Unit, T>

impl<Unit, T: Clone + Ord> Ord for Length<Unit, T>

fn cmp(&self, other: &Length<Unit, T>) -> Ordering

This method returns an Ordering between self and other.

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

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