Struct de_uom::Quantity

pub struct Quantity<const U: i32>(pub(crate) f32);

A quantity with associated units.

The units are either base SI units and several extensions (for example m, s, px) or derived units (for example rad, m/s⁻²). Only unit powers up to +/-7 are supported: id est m² or m⁻² are supported but m⁸ is not.

Tuple Fields

0: f32

Implementations

impl<const U: i32> Quantity<U>

pub const ZERO: Self = _

pub const ONE: Self = _

pub const fn new_unchecked(value: f32) -> Self

Creates a new quantity without checking the value.

It is expected that the value is not a NaN. If NaN is given, the type might behave strangely or panic during some of the operations.

pub fn new(value: f32) -> Self

Crates a new quantity.

Panics

Panics if value is NaN.

pub fn abs(&self) -> Self

Returns a new quantity with absolute value of self.

pub const fn inner(&self) -> f32

impl Quantity<DIMENSIONLESS>

pub const FRAC_PI_2: Self = _

The angle equal to π/2.

pub fn normalized(&self) -> Self

Returns a new angle normalized to a values between 0.0 (inclusive) and the full circle constant τ (exclusive).

Trait Implementations

impl<const U: i32> Add for Quantity<U>

type Output = Quantity<U>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<const U: i32> AddAssign for Quantity<U>

fn add_assign(&mut self, other: Self)

Performs the += operation.

impl<const U: i32> Clone for Quantity<U>

fn clone(&self) -> Quantity<U>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<const U: i32> Debug for Quantity<U>

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

Formats the value using the given formatter.

impl<const U: i32> Div<f32> for Quantity<U>

type Output = Quantity<U>

The resulting type after applying the / operator.

fn div(self, rhs: f32) -> Self

Performs the / operation.

impl<const U: i32> DivAssign<f32> for Quantity<U>

fn div_assign(&mut self, rhs: f32)

Performs the /= operation.

impl<const U: i32> From<Quantity<U>> for f32

fn from(quantity: Quantity<U>) -> f32

Converts to this type from the input type.

impl Mul<Quantity<{ -$units }>> for Quantity<PIXEL>

type Output = f32

The resulting type after applying the * operator.

fn mul(self, rhs: Quantity<{ _ }>) -> Self::Output

Performs the * operation.

impl Mul<Quantity<{ -$units }>> for Quantity<SECOND>

type Output = f32

The resulting type after applying the * operator.

fn mul(self, rhs: Quantity<{ _ }>) -> Self::Output

Performs the * operation.

impl Mul<Quantity<PIXEL>> for Quantity<{ _ }>

type Output = f32

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Quantity<SECOND>> for Quantity<{ _ }>

type Output = f32

The resulting type after applying the * operator.

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

Performs the * operation.

impl<const U: i32> Mul<Quantity<U>> for f32

type Output = Quantity<U>

The resulting type after applying the * operator.

fn mul(self, rhs: Quantity<U>) -> Quantity<U>

Performs the * operation.

impl<const U: i32> Mul<f32> for Quantity<U>

type Output = Quantity<U>

The resulting type after applying the * operator.

fn mul(self, rhs: f32) -> Self

Performs the * operation.

impl<const U: i32> MulAssign<f32> for Quantity<U>

fn mul_assign(&mut self, rhs: f32)

Performs the *= operation.

impl<const U: i32> Neg for Quantity<U>

type Output = Quantity<U>

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl<const U: i32> Ord for Quantity<U>

fn cmp(&self, other: &Self) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl<const U: i32> PartialEq for Quantity<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<const U: i32> PartialOrd for Quantity<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<const U: i32> Sub for Quantity<U>

type Output = Quantity<U>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<const U: i32> SubAssign for Quantity<U>

fn sub_assign(&mut self, other: Self)

Performs the -= operation.

impl<const U: i32> TryFrom<f32> for Quantity<U>

type Error = QuantityValueError

The type returned in the event of a conversion error.

fn try_from(value: f32) -> Result<Self, Self::Error>

Performs the conversion.

impl<const U: i32> Copy for Quantity<U>

impl<const U: i32> Eq for Quantity<U>