[−][src]Struct euclid::Length
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.
Methods
impl<T, Unit> Length<T, Unit>
[src]
impl<T, Unit> Length<T, Unit>
impl<Unit, T: Clone> Length<T, Unit>
[src]
impl<Unit, T: Clone> Length<T, Unit>
impl<Unit, T0: NumCast + Clone> Length<T0, Unit>
[src]
impl<Unit, T0: NumCast + Clone> Length<T0, Unit>
pub fn cast<T1: NumCast + Clone>(&self) -> Length<T1, Unit> | [src] |
Cast from one numeric representation to another, preserving the units.
pub fn try_cast<T1: NumCast + Clone>(&self) -> Option<Length<T1, Unit>> | [src] |
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>,
[src]
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 | [src] |
Linearly interpolate between this length and another length.
t
is expected to be between zero and one.
Trait Implementations
impl<Unit, T: Zero> Zero for Length<T, Unit>
[src]
impl<Unit, T: Zero> Zero for Length<T, Unit>
impl<T: Copy, Unit> Copy for Length<T, Unit>
[src]
impl<T: Copy, Unit> Copy for Length<T, Unit>
impl<T: Display + Clone, U> Display for Length<T, U>
[src]
impl<T: Display + Clone, U> Display for Length<T, U>
impl<T: Debug + Clone, U> Debug for Length<T, U>
[src]
impl<T: Debug + Clone, U> Debug for Length<T, U>
impl<U, T: Clone + Sub<T, Output = T>> Sub<Length<T, U>> for Length<T, U>
[src]
impl<U, T: Clone + 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 | [src] |
impl<Unit, T: Clone + PartialEq> PartialEq<Length<T, Unit>> for Length<T, Unit>
[src]
impl<Unit, T: Clone + PartialEq> PartialEq<Length<T, Unit>> for Length<T, Unit>
fn eq(&self, other: &Self) -> bool | [src] |
| 1.0.0 [src] |
This method tests for !=
.
impl<Unit, T: Clone + Eq> Eq for Length<T, Unit>
[src]
impl<Unit, T: Clone + Eq> Eq for Length<T, Unit>
impl<Unit, T: Clone + Ord> Ord for Length<T, Unit>
[src]
impl<Unit, T: Clone + Ord> Ord for Length<T, Unit>
fn cmp(&self, other: &Self) -> Ordering | [src] |
fn max(self, other: Self) -> Self | 1.21.0 [src] |
Compares and returns the maximum of two values. Read more
fn min(self, other: Self) -> Self | 1.21.0 [src] |
Compares and returns the minimum of two values. Read more
impl<Unit, T: Clone + PartialOrd> PartialOrd<Length<T, Unit>> for Length<T, Unit>
[src]
impl<Unit, T: Clone + PartialOrd> PartialOrd<Length<T, Unit>> for Length<T, Unit>
fn partial_cmp(&self, other: &Self) -> Option<Ordering> | [src] |
| 1.0.0 [src] |
This method tests less than (for self
and other
) and is used by the <
operator. Read more
| 1.0.0 [src] |
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
| 1.0.0 [src] |
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
| 1.0.0 [src] |
This method tests greater than or equal to (for self
and other
) and is used by the >=
operator. Read more
impl<U, T: Clone + Add<T, Output = T>> Add<Length<T, U>> for Length<T, U>
[src]
impl<U, T: Clone + 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> | [src] |
impl<T: Copy + Mul<T, Output = T>, U> Mul<T> for Length<T, U>
[src]
impl<T: Copy + 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 | [src] |
impl<Src, Dst, T: Clone + Mul<T, Output = T>> Mul<TypedScale<T, Src, Dst>> for Length<T, Src>
[src]
impl<Src, Dst, T: Clone + Mul<T, Output = T>> Mul<TypedScale<T, Src, Dst>> for Length<T, Src>
type Output = Length<T, Dst>
The resulting type after applying the *
operator.
fn mul(self, scale: TypedScale<T, Src, Dst>) -> Length<T, Dst> | [src] |
impl<Src, Dst, T: Clone + Div<T, Output = T>> Div<Length<T, Src>> for Length<T, Dst>
[src]
impl<Src, Dst, T: Clone + Div<T, Output = T>> Div<Length<T, Src>> for Length<T, Dst>
type Output = TypedScale<T, Src, Dst>
The resulting type after applying the /
operator.
fn div(self, other: Length<T, Src>) -> TypedScale<T, Src, Dst> | [src] |
impl<T: Copy + Div<T, Output = T>, U> Div<T> for Length<T, U>
[src]
impl<T: Copy + 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 | [src] |
impl<Src, Dst, T: Clone + Div<T, Output = T>> Div<TypedScale<T, Src, Dst>> for Length<T, Dst>
[src]
impl<Src, Dst, T: Clone + Div<T, Output = T>> Div<TypedScale<T, Src, Dst>> for Length<T, Dst>
type Output = Length<T, Src>
The resulting type after applying the /
operator.
fn div(self, scale: TypedScale<T, Src, Dst>) -> Length<T, Src> | [src] |
impl<U, T: Clone + Neg<Output = T>> Neg for Length<T, U>
[src]
impl<U, T: Clone + 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> | [src] |
impl<U, T: Clone + AddAssign<T>> AddAssign<Length<T, U>> for Length<T, U>
[src]
impl<U, T: Clone + AddAssign<T>> AddAssign<Length<T, U>> for Length<T, U>
fn add_assign(&mut self, other: Length<T, U>) | [src] |
impl<U, T: Clone + SubAssign<T>> SubAssign<Length<T, U>> for Length<T, U>
[src]
impl<U, T: Clone + SubAssign<T>> SubAssign<Length<T, U>> for Length<T, U>
fn sub_assign(&mut self, other: Length<T, U>) | [src] |
impl<T: Copy + Mul<T, Output = T>, U> MulAssign<T> for Length<T, U>
[src]
impl<T: Copy + Mul<T, Output = T>, U> MulAssign<T> for Length<T, U>
fn mul_assign(&mut self, scale: T) | [src] |
impl<T: Copy + Div<T, Output = T>, U> DivAssign<T> for Length<T, U>
[src]
impl<T: Copy + Div<T, Output = T>, U> DivAssign<T> for Length<T, U>
fn div_assign(&mut self, scale: T) | [src] |
impl<T: Clone, Unit> Clone for Length<T, Unit>
[src]
impl<T: Clone, Unit> Clone for Length<T, Unit>
fn clone(&self) -> Self | [src] |
fn clone_from(&mut self, source: &Self) | 1.0.0 [src] |
Performs copy-assignment from source
. Read more
impl<U, T: Clone + Saturating> Saturating for Length<T, U>
[src]
impl<U, T: Clone + Saturating> Saturating for Length<T, U>
fn saturating_add(self, other: Length<T, U>) -> Length<T, U> | [src] |
fn saturating_sub(self, other: Length<T, U>) -> Length<T, U> | [src] |
Auto Trait Implementations
impl<T, Unit> Send for Length<T, Unit> where
T: Send,
Unit: Send,
impl<T, Unit> Send for Length<T, Unit> where
T: Send,
Unit: Send,
impl<T, Unit> Sync for Length<T, Unit> where
T: Sync,
Unit: Sync,
impl<T, Unit> Sync for Length<T, Unit> where
T: Sync,
Unit: Sync,
Blanket Implementations
impl<T> Zero for T where
T: Zero,
[src]
impl<T> Zero for T where
T: Zero,
impl<T, U> TryFrom for T where
T: From<U>,
[src]
impl<T, U> TryFrom for T where
T: From<U>,
type Error = !
try_from
)The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error> | [src] |
impl<T> From for T
[src]
impl<T> From for T
impl<T, U> TryInto for T where
U: TryFrom<T>,
[src]
impl<T, U> TryInto for T where
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
try_from
)The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error> | [src] |
impl<T, U> Into for T where
U: From<T>,
[src]
impl<T, U> Into for T where
U: From<T>,
impl<T> Borrow for T where
T: ?Sized,
[src]
impl<T> Borrow for T where
T: ?Sized,
impl<T> BorrowMut for T where
T: ?Sized,
[src]
impl<T> BorrowMut for T where
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T | [src] |
impl<T> Any for T where
T: 'static + ?Sized,
[src]
impl<T> Any for T where
T: 'static + ?Sized,
fn get_type_id(&self) -> TypeId | [src] |
impl<T> ToOwned for T where
T: Clone,
[src]
impl<T> ToOwned for T where
T: Clone,
impl<T> ToString for T where
T: Display + ?Sized,
[src]
impl<T> ToString for T where
T: Display + ?Sized,