Struct uy::Quantity

#[repr(transparent)]
pub struct Quantity<T, U: Unit> { /* private fields */ }

A physical quantity with a defined unit.

Implementations

impl<T, U: Unit> Quantity<T, U>

pub fn new(val: T) -> Self

Create a quantity from a value.

pub fn convert<Y: UnitConvert<T, U>>(self) -> Quantity<T, Y>

Convert between quantities with different units or the same units with different scales.

let a: Quantity<i32, si::m> = Quantity::new(3);
let b: Quantity<i32, si::milli<si::m>> = a.convert();
assert_eq!(*b, 3000);

Trait Implementations

impl<T, U: Unit> Add<Quantity<T, U>> for Quantity<T, U>where T: Add<Output = T>,

type Output = Quantity<T, U>

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self

Performs the + operation.

impl<T: Clone, U: Unit> Clone for Quantity<T, U>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug, U: Debug + Unit> Debug for Quantity<T, U>

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

Formats the value using the given formatter.

impl<T, U: Unit> Deref for Quantity<T, U>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<T, U: Unit> DerefMut for Quantity<T, U>

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

Mutably dereferences the value.

impl<T, U1, U2: Unit> Div<Quantity<T, U2>> for Quantity<T, U1>where T: Div<Output = T>, U1: Div<U2> + Unit, <U1 as Div<U2>>::Output: Unit,

type Output = Quantity<T, <U1 as Div<U2>>::Output>

The resulting type after applying the / operator.

fn div(self, rhs: Quantity<T, U2>) -> Self::Output

Performs the / operation.

impl<T, U: Unit> From<T> for Quantity<T, U>

fn from(val: T) -> Self

Converts to this type from the input type.

impl<T: Hash, U: Unit> Hash for Quantity<T, U>

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

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<T, U1, U2: Unit> Mul<Quantity<T, U2>> for Quantity<T, U1>where T: Mul<Output = T>, U1: Mul<U2> + Unit, <U1 as Mul<U2>>::Output: Unit,

type Output = Quantity<T, <U1 as Mul<U2>>::Output>

The resulting type after applying the * operator.

fn mul(self, rhs: Quantity<T, U2>) -> Self::Output

Performs the * operation.

impl<T: Ord, U: Unit> Ord for Quantity<T, U>

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl<T: PartialEq, U: Unit> PartialEq<Quantity<T, U>> for Quantity<T, U>

fn eq(&self, other: &Self) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: PartialOrd, U: Unit> PartialOrd<Quantity<T, U>> for Quantity<T, U>

fn partial_cmp(&self, other: &Self) -> 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<T, U: Unit> Sub<Quantity<T, U>> for Quantity<T, U>where T: Sub<Output = T>,

type Output = Quantity<T, U>

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self

Performs the - operation.

impl<T: Copy, U: Unit> Copy for Quantity<T, U>

impl<T: Eq, U: Unit> Eq for Quantity<T, U>