Struct dec::OrderedDecimal

pub struct OrderedDecimal<D>(pub D);

A wrapper for a decimal number that provides an implementation of Ord and Hash.

Like the OrderedFloat type provided by the ordered_float crate, but for decimals.

NaN is treated as equal to itself and greater than all non-NaN values. All other values are compared via their PartialOrd implementation.

At the moment OrderedDecimal can only wrap Decimal64 and Decimal128. Support for Decimal32 is not planned, but support for Decimal<N> would be welcomed, provided a suitable implementation can be found.

Note that the order used by OrderedDecimal is not the same as the order used by the total_cmp method. The total_cmp method takes exponents into account and therefore does not consider e.g. 1.2 and 1.20 to be equal.

Implementations

impl<D> OrderedDecimal<D>

pub fn into_inner(self) -> D

Consumes the ordered decimal wrapper, returning the decimal within.

Trait Implementations

impl<D> Add<D> for OrderedDecimal<D> where
    D: Add<Output = D>, 

type Output = Self

The resulting type after applying the + operator.

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

Performs the + operation.

impl<D> Add<OrderedDecimal<D>> for OrderedDecimal<D> where
    D: Add<Output = D>, 

type Output = Self

The resulting type after applying the + operator.

fn add(self, other: OrderedDecimal<D>) -> Self

Performs the + operation.

impl Add<OrderedDecimal<Decimal128>> for Decimal128

type Output = Self

The resulting type after applying the + operator.

fn add(self, other: OrderedDecimal<Decimal128>) -> Self

Performs the + operation.

impl Add<OrderedDecimal<Decimal64>> for Decimal64

type Output = Self

The resulting type after applying the + operator.

fn add(self, other: OrderedDecimal<Decimal64>) -> Self

Performs the + operation.

impl<D> AddAssign<D> for OrderedDecimal<D> where
    D: Add<Output = D> + Copy, 

Adds inner directly.

fn add_assign(&mut self, other: D)

Performs the += operation.

impl<D> AddAssign<OrderedDecimal<D>> for OrderedDecimal<D> where
    D: AddAssign, 

fn add_assign(&mut self, other: Self)

Performs the += operation.

impl<D: Clone> Clone for OrderedDecimal<D>

fn clone(&self) -> OrderedDecimal<D>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<D: Copy> Copy for OrderedDecimal<D>

impl<D: Debug> Debug for OrderedDecimal<D>

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

Formats the value using the given formatter.

impl<D> Default for OrderedDecimal<D> where
    D: Default, 

fn default() -> Self

Returns the “default value” for a type.

impl<D> Display for OrderedDecimal<D> where
    D: Display, 

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

Formats the value using the given formatter.

impl<D> Div<D> for OrderedDecimal<D> where
    D: Div<Output = D>, 

type Output = Self

The resulting type after applying the / operator.

fn div(self, other: D) -> Self

Performs the / operation.

impl<D> Div<OrderedDecimal<D>> for OrderedDecimal<D> where
    D: Div<Output = D>, 

type Output = Self

The resulting type after applying the / operator.

fn div(self, other: OrderedDecimal<D>) -> Self

Performs the / operation.

impl Div<OrderedDecimal<Decimal128>> for Decimal128

type Output = Self

The resulting type after applying the / operator.

fn div(self, other: OrderedDecimal<Decimal128>) -> Self

Performs the / operation.

impl Div<OrderedDecimal<Decimal64>> for Decimal64

type Output = Self

The resulting type after applying the / operator.

fn div(self, other: OrderedDecimal<Decimal64>) -> Self

Performs the / operation.

impl<D> DivAssign<D> for OrderedDecimal<D> where
    D: Div<Output = D> + Copy, 

Divs inner directly.

fn div_assign(&mut self, other: D)

Performs the /= operation.

impl<D> DivAssign<OrderedDecimal<D>> for OrderedDecimal<D> where
    D: DivAssign, 

fn div_assign(&mut self, other: Self)

Performs the /= operation.

impl<D> Eq for OrderedDecimal<D> where
    Self: Ord, 

impl<D> From<Decimal128> for OrderedDecimal<D> where
    D: From<Decimal128>, 

fn from(n: Decimal128) -> OrderedDecimal<D>

Performs the conversion.

impl<D> From<Decimal32> for OrderedDecimal<D> where
    D: From<Decimal32>, 

fn from(n: Decimal32) -> OrderedDecimal<D>

Performs the conversion.

impl<D> From<Decimal64> for OrderedDecimal<D> where
    D: From<Decimal64>, 

fn from(n: Decimal64) -> OrderedDecimal<D>

Performs the conversion.

impl<D> From<i32> for OrderedDecimal<D> where
    D: From<i32>, 

fn from(n: i32) -> OrderedDecimal<D>

Performs the conversion.

impl<D> From<u32> for OrderedDecimal<D> where
    D: From<u32>, 

fn from(n: u32) -> OrderedDecimal<D>

Performs the conversion.

impl<D> FromStr for OrderedDecimal<D> where
    D: FromStr<Err = ParseDecimalError>, 

type Err = ParseDecimalError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<OrderedDecimal<D>, ParseDecimalError>

Parses a string s to return a value of this type.

impl Hash for OrderedDecimal<Decimal64>

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl Hash for OrderedDecimal<Decimal128>

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl<D> Mul<D> for OrderedDecimal<D> where
    D: Mul<Output = D>, 

type Output = Self

The resulting type after applying the * operator.

fn mul(self, other: D) -> Self

Performs the * operation.

impl<D> Mul<OrderedDecimal<D>> for OrderedDecimal<D> where
    D: Mul<Output = D>, 

type Output = Self

The resulting type after applying the * operator.

fn mul(self, other: OrderedDecimal<D>) -> Self

Performs the * operation.

impl Mul<OrderedDecimal<Decimal128>> for Decimal128

type Output = Self

The resulting type after applying the * operator.

fn mul(self, other: OrderedDecimal<Decimal128>) -> Self

Performs the * operation.

impl Mul<OrderedDecimal<Decimal64>> for Decimal64

type Output = Self

The resulting type after applying the * operator.

fn mul(self, other: OrderedDecimal<Decimal64>) -> Self

Performs the * operation.

impl<D> MulAssign<D> for OrderedDecimal<D> where
    D: Mul<Output = D> + Copy, 

Muls inner directly.

fn mul_assign(&mut self, other: D)

Performs the *= operation.

impl<D> MulAssign<OrderedDecimal<D>> for OrderedDecimal<D> where
    D: MulAssign, 

fn mul_assign(&mut self, other: Self)

Performs the *= operation.

impl<D> Neg for OrderedDecimal<D> where
    D: Neg<Output = D>, 

type Output = Self

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl Ord for OrderedDecimal<Decimal64>

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

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl Ord for OrderedDecimal<Decimal128>

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

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl<D> PartialEq<OrderedDecimal<D>> for OrderedDecimal<D> where
    Self: Ord, 

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<D> PartialOrd<OrderedDecimal<D>> for OrderedDecimal<D> where
    Self: Ord, 

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub 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<'a, D> Product<&'a OrderedDecimal<D>> for OrderedDecimal<D> where
    D: Product<&'a D> + 'a, 

fn product<I>(iter: I) -> Self where
    I: Iterator<Item = &'a OrderedDecimal<D>>, 

Method which takes an iterator and generates Self from the elements by multiplying the items.

impl<D> Product<OrderedDecimal<D>> for OrderedDecimal<D> where
    D: Product, 

fn product<I>(iter: I) -> Self where
    I: Iterator<Item = OrderedDecimal<D>>, 

Method which takes an iterator and generates Self from the elements by multiplying the items.

impl<D> Rem<D> for OrderedDecimal<D> where
    D: Rem<Output = D>, 

type Output = Self

The resulting type after applying the % operator.

fn rem(self, other: D) -> Self

Performs the % operation.

impl<D> Rem<OrderedDecimal<D>> for OrderedDecimal<D> where
    D: Rem<Output = D>, 

type Output = Self

The resulting type after applying the % operator.

fn rem(self, other: OrderedDecimal<D>) -> Self

Performs the % operation.

impl Rem<OrderedDecimal<Decimal128>> for Decimal128

type Output = Self

The resulting type after applying the % operator.

fn rem(self, other: OrderedDecimal<Decimal128>) -> Self

Performs the % operation.

impl Rem<OrderedDecimal<Decimal64>> for Decimal64

type Output = Self

The resulting type after applying the % operator.

fn rem(self, other: OrderedDecimal<Decimal64>) -> Self

Performs the % operation.

impl<D> RemAssign<D> for OrderedDecimal<D> where
    D: Rem<Output = D> + Copy, 

Rems inner directly.

fn rem_assign(&mut self, other: D)

Performs the %= operation.

impl<D> RemAssign<OrderedDecimal<D>> for OrderedDecimal<D> where
    D: RemAssign, 

fn rem_assign(&mut self, other: Self)

Performs the %= operation.

impl<D> Sub<D> for OrderedDecimal<D> where
    D: Sub<Output = D>, 

type Output = Self

The resulting type after applying the - operator.

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

Performs the - operation.

impl<D> Sub<OrderedDecimal<D>> for OrderedDecimal<D> where
    D: Sub<Output = D>, 

type Output = Self

The resulting type after applying the - operator.

fn sub(self, other: OrderedDecimal<D>) -> Self

Performs the - operation.

impl Sub<OrderedDecimal<Decimal128>> for Decimal128

type Output = Self

The resulting type after applying the - operator.

fn sub(self, other: OrderedDecimal<Decimal128>) -> Self

Performs the - operation.

impl Sub<OrderedDecimal<Decimal64>> for Decimal64

type Output = Self

The resulting type after applying the - operator.

fn sub(self, other: OrderedDecimal<Decimal64>) -> Self

Performs the - operation.

impl<D> SubAssign<D> for OrderedDecimal<D> where
    D: Sub<Output = D> + Copy, 

Subs inner directly.

fn sub_assign(&mut self, other: D)

Performs the -= operation.

impl<D> SubAssign<OrderedDecimal<D>> for OrderedDecimal<D> where
    D: SubAssign, 

fn sub_assign(&mut self, other: Self)

Performs the -= operation.

impl<'a, D> Sum<&'a OrderedDecimal<D>> for OrderedDecimal<D> where
    D: Sum<&'a D> + 'a, 

fn sum<I>(iter: I) -> Self where
    I: Iterator<Item = &'a OrderedDecimal<D>>, 

Method which takes an iterator and generates Self from the elements by “summing up” the items.

impl<D> Sum<OrderedDecimal<D>> for OrderedDecimal<D> where
    D: Sum, 

fn sum<I>(iter: I) -> Self where
    I: Iterator<Item = OrderedDecimal<D>>, 

Method which takes an iterator and generates Self from the elements by “summing up” the items.