Struct monetary::Rate

pub struct Rate<A, B>(/* private fields */);

A rate representing A / B.

Implementations

impl<A, B> Rate<A, B>

pub fn new(rate: Decimal) -> Option<Self>

Create a new rate from a decimal. Returns None if the rate is zero.

pub unsafe fn new_unchecked(rate: Decimal) -> Self

Create a new rate from a decimal without checking if it is zero.

Safety

The user ensures that the rate is non-zero. Violating this contract will lead to

pub fn rate(&self) -> Decimal

pub fn inv(&self) -> Rate<B, A>

pub fn add_decimal(&self, decimal: Decimal) -> StdResult<Rate<A, B>>

Adds a Decimal value to this. This is useful for adding a directly calculated decimal to a typed rate.

pub fn sub_decimal(&self, decimal: Decimal) -> StdResult<Rate<A, B>>

Subtracts a Decimal value from this. This is useful for subtracting a directly calculated decimal from a typed rate.

impl<A, B> Rate<Precise<A>, Precise<B>>

pub fn new_precise( rate: Decimal, from: &Precise<A>, to: &Precise<B>, ) -> Option<Self>

Trait Implementations

impl<A: Clone, B: Clone> Clone for Rate<A, B>

fn clone(&self) -> Rate<A, B>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<A: Debug, B: Debug> Debug for Rate<A, B>

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

Formats the value using the given formatter.

impl<'de, A, B> Deserialize<'de> for Rate<A, B>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<A, B> Display for Rate<A, B>

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

Formats the value using the given formatter.

impl<N, S, D> Div<Rate<D, S>> for Rate<N, S>

type Output = Rate<N, D>

The resulting type after applying the / operator.

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

Performs the / operation.

impl<A: JsonSchema, B: JsonSchema> JsonSchema for Rate<A, B>

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

impl<N, S, D> Mul<Rate<S, D>> for Rate<N, S>

type Output = Rate<N, D>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<A: PartialEq, B: PartialEq> PartialEq for Rate<A, B>

fn eq(&self, other: &Rate<A, B>) -> 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<A, B> Serialize for Rate<A, B>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<A: Copy, B: Copy> Copy for Rate<A, B>

impl<A: Eq, B: Eq> Eq for Rate<A, B>

impl<A, B> StructuralPartialEq for Rate<A, B>