zng_layout::unit::euclid

Struct Length

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

Expand description

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. Read more

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. Read more

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

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

Performs the += operation. Read more

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. Read more

1.0.0 · source§

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

Performs copy-assignment from source. Read more

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. Read more

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

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

Returns the “default value” for a type. Read more

impl<'de, T, U> Deserialize<'de> for Length<T, U>
where T: Deserialize<'de>,

fn deserialize<D>( deserializer: D, ) -> Result<Length<T, U>, <D as Deserializer<'de>>::Error>
where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

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. Read more

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. Read more

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. Read more

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. Read more

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. Read more

1.3.0 · source§

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

Feeds a slice of this type into the given Hasher. Read more

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. Read more

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. Read more

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. Read more

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. Read more

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. Read more

1.21.0 · source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more

1.21.0 · source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more

1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more

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 ==.

1.0.0 · source§

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. Read more

1.0.0 · source§

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

Tests less than (for self and other) and is used by the < operator. Read more

1.0.0 · source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more

1.0.0 · source§

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

Tests greater than (for self and other) and is used by the > operator. Read more

1.0.0 · source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more

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

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more

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. Read more

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

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

Performs the -= operation. Read more

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> Transitionable for Length<T, U>
where T: Transitionable, U: Send + Sync + Any,

fn lerp(self, to: &Length<T, U>, step: Factor) -> Length<T, U>

Sample the linear interpolation from self -> to by step.

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

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

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

fn zeroed() -> Self

Calls zeroed. Read more

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

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

impl<T, U> Pod for Length<T, U>
where T: Pod, U: 'static,

Auto Trait Implementations§

impl<T, Unit> Freeze for Length<T, Unit>
where T: Freeze,

impl<T, Unit> RefUnwindSafe for Length<T, Unit>
where T: RefUnwindSafe, Unit: RefUnwindSafe,

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> Unpin for Length<T, Unit>
where T: Unpin, Unit: Unpin,

impl<T, Unit> UnwindSafe for Length<T, Unit>
where T: UnwindSafe, Unit: UnwindSafe,

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> AnyVarValue for T
where T: VarValue,

fn as_any(&self) -> &(dyn Any + 'static)

Access to dyn Any methods.

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Access to mut dyn Any methods.

fn clone_boxed(&self) -> Box<dyn AnyVarValue>

Clone the value.

fn clone_boxed_var(&self) -> Box<dyn AnyVar>

Clone the value into a new boxed LocalVar<Self>.

fn into_any(self: Box<T>) -> Box<dyn Any>

Access to Box<dyn Any> methods.

fn eq_any(&self, other: &(dyn AnyVarValue + 'static)) -> bool

Gets if self equals other.

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CheckedBitPattern for T
where T: AnyBitPattern,

type Bits = T

Self must have the same layout as the specified Bits except for the possible invalid bit patterns being checked during is_valid_bit_pattern.

fn is_valid_bit_pattern(_bits: &T) -> bool

If this function returns true, then it must be valid to reinterpret bits as &Self.

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dst: *mut T)

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

Performs copy-assignment from self to dst. Read more

impl<Q, K> Comparable<K> for Q
where Q: Ord + ?Sized, K: Borrow<Q> + ?Sized,

fn compare(&self, key: &K) -> Ordering

Compare self to key and return their ordering.

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

impl<T> IntoVar<T> for T
where T: VarValue,

type Var = LocalVar<T>

Variable type that will wrap the T value. Read more

fn into_var(self) -> <T as IntoVar<T>>::Var

Converts the source value into a var.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>
where Self: Sized,

Converts into BoxedVar<T>. Read more

impl<T> Pointable for T

const ALIGN: usize = _

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more

impl<T> AnyBitPattern for T
where T: Pod,

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

impl<T> IntoValue<T> for T
where T: VarValue,

impl<T> NoUninit for T
where T: Pod,

impl<T> VarValue for T
where T: Debug + Clone + PartialEq + Any + Send + Sync,