Struct Rate 

pub struct Rate<TQ, PQ>
where
    TQ: Quantity,
    PQ: Quantity,
{ /* private fields */ }

The ratio between two related quantity values.

Implementations

impl<TQ, PQ> Rate<TQ, PQ>

where TQ: Quantity, PQ: Quantity,

pub const fn new( term_amount: Decimal, term_unit: <TQ as Quantity>::UnitType, per_unit_multiple: Decimal, per_unit: <PQ as Quantity>::UnitType, ) -> Rate<TQ, PQ>

Returns a new instance of Rate with attributes equal to given params.

pub fn from_qty_vals(term: TQ, per: PQ) -> Rate<TQ, PQ>

Returns a new instance of Rate with attributes extracted from the given quantity values.

pub const fn term_amount(&self) -> Decimal

Returns the term amount of self.

pub const fn term_unit(&self) -> <TQ as Quantity>::UnitType

Returns the term unit of self.

pub const fn per_unit_multiple(&self) -> Decimal

Returns the per unit multiple of self.

pub const fn per_unit(&self) -> <PQ as Quantity>::UnitType

Returns the per unit of self.

pub const fn reciprocal(&self) -> Rate<PQ, TQ>

Returns the multiplicative inverse of self

Trait Implementations

impl<TQ, PQ> Clone for Rate<TQ, PQ>

where TQ: Clone + Quantity, PQ: Clone + Quantity, <TQ as Quantity>::UnitType: Clone, <PQ as Quantity>::UnitType: Clone,

fn clone(&self) -> Rate<TQ, PQ>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<TQ, PQ> Debug for Rate<TQ, PQ>

where TQ: Debug + Quantity, PQ: Debug + Quantity, <TQ as Quantity>::UnitType: Debug, <PQ as Quantity>::UnitType: Debug,

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

Formats the value using the given formatter.

impl<TQ, PQ> Display for Rate<TQ, PQ>

where TQ: Quantity, PQ: Quantity,

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

Formats the value using the given formatter.

impl<PQ: Quantity> Div<Rate<Money, PQ>> for Money

fn div(self, rhs: Rate<Self, PQ>) -> Self::Output

Returns an instance of PQ eqivalent to self according to rhs.

Example:

let d = Dec!(7.5) * USD;
let r = Rate::<Money, Mass>::new(Dec!(3), USD, Dec!(10), KILOGRAM);
let m = d / r;
assert_eq!(m, Dec!(25) * KILOGRAM);

Panics

The function panics in the following cases:

• rhs.term_unit() is not identical to self.unit()

type Output = PQ

The resulting type after applying the / operator.

impl<TQ, PQ> Mul<PQ> for Rate<TQ, PQ>

where TQ: Quantity, PQ: Quantity + Div<Output = Decimal>,

type Output = TQ

The resulting type after applying the * operator.

fn mul(self, rhs: PQ) -> <Rate<TQ, PQ> as Mul<PQ>>::Output

Performs the * operation.

impl<TQ: Quantity> Mul<Rate<TQ, Money>> for Money

fn mul(self, rhs: Rate<TQ, Self>) -> Self::Output

Returns an instance of TQ eqivalent to self according to rhs.

Example:

let d = Dec!(7.5) * USD;
let r = Rate::<Mass, Money>::new(Dec!(3.5), KILOGRAM, Dec!(10), USD);
let m = d * r;
assert_eq!(m, Dec!(2.625) * KILOGRAM);

Panics

The function panics in the following cases:

• rhs.per_unit() is not identical to self.unit()

type Output = TQ

The resulting type after applying the * operator.

impl<TQ, PQ> Copy for Rate<TQ, PQ>

where TQ: Copy + Quantity, PQ: Copy + Quantity, <TQ as Quantity>::UnitType: Copy, <PQ as Quantity>::UnitType: Copy,