Struct Decimal 

#[repr(transparent)]
pub struct Decimal<I, const D: u8>(pub I);

Tuple Fields

0: I

Implementations

impl<I, const D: u8> Decimal<I, D>

where I: ScaledInteger<D>,

pub fn to_f64(&self) -> f64

pub fn to_f32(&self) -> f32

impl<I, const D: u8> Decimal<I, D>

where I: ScaledInteger<D>,

pub const ZERO: Decimal<I, D>

pub const ONE: Decimal<I, D>

pub const TWO: Decimal<I, D>

pub const MIN: Decimal<I, D>

pub const MAX: Decimal<I, D>

pub const DECIMALS: u8 = D

pub const SCALING_FACTOR: I = I::SCALING_FACTOR

pub const fn min() -> Self

👎Deprecated:

use Self::MIN

pub const fn max() -> Self

👎Deprecated:

use Self::MAX

pub fn try_from_scaled(integer: I, scale: u8) -> Option<Self>

Losslessly converts a scaled integer to this type.

Examples

use const_decimal::Decimal;

let five = Decimal::<u64, 3>::try_from_scaled(5, 0).unwrap();
assert_eq!(five, Decimal::TWO + Decimal::TWO + Decimal::ONE);
assert_eq!(five.0, 5000);

pub fn is_zero(&self) -> bool

pub fn quantize_round_to_zero(&self, quantum: Self) -> Self

Round a number to a multiple of a given quantum toward zero. general ref: https://en.wikipedia.org/wiki/Quantization_(signal_processing)

By default, rust is rounding towards zero and so does this method.

Example:

use const_decimal::Decimal;
// 11.65
let d = Decimal::<i64, 5>::try_from_scaled(1165, 2).unwrap();
// Allow only increments of 0.5
let quantum = Decimal::<i64, 5>::try_from_scaled(5, 1).unwrap();
let q = d.quantize_round_to_zero(quantum);
// 11.5 rounded down to the nearest `quantum`.
assert_eq!(q, Decimal::try_from_scaled(115, 1).unwrap());

Trait Implementations

impl<I, const D: u8> Add for Decimal<I, D>

where I: ScaledInteger<D>,

type Output = Decimal<I, D>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<I, const D: u8> AddAssign for Decimal<I, D>

where I: ScaledInteger<D>,

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl<I: Clone, const D: u8> Clone for Decimal<I, D>

fn clone(&self) -> Decimal<I, D>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<I: Copy, const D: u8> Copy for Decimal<I, D>

impl<I: Debug, const D: u8> Debug for Decimal<I, D>

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

Formats the value using the given formatter.

impl<I: Default, const D: u8> Default for Decimal<I, D>

fn default() -> Decimal<I, D>

Returns the “default value” for a type.

impl<I, const D: u8> Display for Decimal<I, D>

where I: ScaledInteger<D>,

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

Formats the value using the given formatter.

impl<I, const D: u8> Div for Decimal<I, D>

where I: ScaledInteger<D>,

type Output = Decimal<I, D>

The resulting type after applying the / operator.

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

Performs the / operation.

impl<I, const D: u8> DivAssign for Decimal<I, D>

where I: ScaledInteger<D>,

fn div_assign(&mut self, rhs: Self)

Performs the /= operation.

impl<I: Eq, const D: u8> Eq for Decimal<I, D>

impl From<Decimal<i64, 9>> for Int128_18

fn from(value: Int64_9) -> Self

Converts to this type from the input type.

impl From<Decimal<u64, 9>> for Uint128_18

fn from(value: Uint64_9) -> Self

Converts to this type from the input type.

impl<I, const D: u8> FromStr for Decimal<I, D>

where I: ScaledInteger<D>,

type Err = ParseDecimalError<I>

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

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

impl<I: Hash, const D: u8> Hash for Decimal<I, D>

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<I, const D: u8> Mul for Decimal<I, D>

where I: ScaledInteger<D>,

type Output = Decimal<I, D>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<I, const D: u8> MulAssign for Decimal<I, D>

where I: ScaledInteger<D>,

fn mul_assign(&mut self, rhs: Self)

Performs the *= operation.

impl<I, const D: u8> Neg for Decimal<I, D>

where I: SignedScaledInteger<D>,

type Output = Decimal<I, D>

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl<I, const D: u8> Num for Decimal<I, D>

where I: SignedScaledInteger<D>,

type FromStrRadixErr = ParseDecimalError<I>

fn from_str_radix(str: &str, radix: u32) -> Result<Self, Self::FromStrRadixErr>

Convert from a string and radix (typically 2..=36).

impl<I, const D: u8> One for Decimal<I, D>

where I: ScaledInteger<D>,

fn one() -> Self

Returns the multiplicative identity element of Self, 1.

fn set_one(&mut self)

Sets self to the multiplicative identity element of Self, 1.

fn is_one(&self) -> bool

where Self: PartialEq,

Returns true if self is equal to the multiplicative identity.

impl<I: Ord, const D: u8> Ord for Decimal<I, D>

fn cmp(&self, other: &Decimal<I, D>) -> 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,

Restrict a value to a certain interval.

impl<I: PartialEq, const D: u8> PartialEq for Decimal<I, D>

fn eq(&self, other: &Decimal<I, D>) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl<I: PartialOrd, const D: u8> PartialOrd for Decimal<I, D>

fn partial_cmp(&self, other: &Decimal<I, D>) -> Option<Ordering>

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

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<I, const D: u8> Rem for Decimal<I, D>

where I: ScaledInteger<D>,

type Output = Decimal<I, D>

The resulting type after applying the % operator.

fn rem(self, rhs: Self) -> Self::Output

Performs the % operation.

impl<I, const D: u8> Signed for Decimal<I, D>

where I: SignedScaledInteger<D>,

fn abs(&self) -> Self

Computes the absolute value.

fn abs_sub(&self, other: &Self) -> Self

The positive difference of two numbers.

fn signum(&self) -> Self

Returns the sign of the number.

fn is_positive(&self) -> bool

Returns true if the number is positive and false if the number is zero or negative.

fn is_negative(&self) -> bool

Returns true if the number is negative and false if the number is zero or positive.

impl<I: PartialEq, const D: u8> StructuralPartialEq for Decimal<I, D>

impl<I, const D: u8> Sub for Decimal<I, D>

where I: ScaledInteger<D>,

type Output = Decimal<I, D>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<I, const D: u8> SubAssign for Decimal<I, D>

where I: ScaledInteger<D>,

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl<I, const D: u8> Zero for Decimal<I, D>

where I: ScaledInteger<D>,

fn zero() -> Self

Returns the additive identity element of Self, 0.

fn is_zero(&self) -> bool

Returns true if self is equal to the additive identity.

fn set_zero(&mut self)

Sets self to the additive identity element of Self, 0.