Struct primitives::unified_num::UnifiedNum

pub struct UnifiedNum(_);

Unified Number with a precision of 8 digits after the decimal point.

The number can be a maximum of u64::MAX (the underlying type), or in a UnifiedNum value 184_467_440_737.09551615. The actual number is handled as a unsigned number and only the display shows the decimal point.

This number is (de)serialized as a Javascript number which is f64. As far as the numbers don’t exceed 2**63, the Javascript number should be sufficient without losing precision

Examples

use primitives::UnifiedNum;
use serde_json::Value;

let unified_num = UnifiedNum::from(42_999_987_654_321);

// Printing the unified num will show the value and the decimal point with precision of `UnifiedNum::PRECISION` (i.e. `8`) numbers after the decimal point
assert_eq!("42999987654321", &unified_num.to_string());

assert_eq!("429999.87654321", &unified_num.to_float_string());

// Printing the Debug of unified num will show the value and the decimal point with precision of `UnifiedNum::PRECISION` (i.e. `8`) numbers after the decimal point
assert_eq!("UnifiedNum(429999.87654321)".to_string(), format!("{:?}", &unified_num));

// JSON Serializing and Deserializing the `UnifiedNum` yields a string without any decimal points
assert_eq!(Value::String("42999987654321".to_string()), serde_json::to_value(unified_num).unwrap());

Implementations

impl UnifiedNum

pub const PRECISION: u8 = 8u8

The precision of the UnifiedNum is 8 decimal numbers after the comma.

pub const MULTIPLIER: u64 = 100_000_000u64

The whole number multiplier when dealing with a UnifiedNum.

Examples

use primitives::UnifiedNum;

let whole_number = 8_u64; // we want to represent 8.00_000_000

assert_eq!(UnifiedNum::from_u64(800_000_000), UnifiedNum::from(whole_number * UnifiedNum::MULTIPLIER));

pub const DEBUG_DELIMITER: char = '.'

pub const ZERO: UnifiedNum = _

pub const ONE: UnifiedNum = _

The whole number 1 as a UnifiedNum. One (1) followed by exactly 8 zeroes (0).

1.00_000_000 100_000_000

pub fn div_floor(&self, other: &Self) -> Self

pub const fn from_u64(value: u64) -> Self

This method creates a UnifiedNum from an inner u64 value.

This method does not take into account precision of UnifiedNum!

pub const fn to_u64(self) -> u64

This method returns the inner u64 representation of the UnifiedNum.

This method does not take into account precision of UnifiedNum!

pub fn to_bignum(self) -> BigNum

pub fn checked_add(&self, rhs: &UnifiedNum) -> Option<Self>

pub fn checked_sub(&self, rhs: &UnifiedNum) -> Option<Self>

pub fn checked_mul(&self, rhs: &UnifiedNum) -> Option<Self>

pub fn checked_div(&self, rhs: &UnifiedNum) -> Option<Self>

pub fn checked_rem(&self, rhs: &UnifiedNum) -> Option<Self>

pub fn to_precision(self, precision: u8) -> BigNum

Transform the UnifiedNum precision 8 to a new precision

pub fn from_precision(amount: BigNum, precision: u8) -> Option<Self>

Transform the BigNum of a given precision to UnifiedNum with precision 8 If the resulting value is larger that what UnifiedNum can hold, it will return None

pub fn to_float_string(self) -> String

Trait Implementations

impl Add<&UnifiedNum> for &UnifiedNum

type Output = UnifiedNum

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<UnifiedNum> for UnifiedNum

type Output = UnifiedNum

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<&UnifiedNum> for UnifiedNum

fn add_assign(&mut self, rhs: &UnifiedNum)

Performs the += operation.

impl CheckedAdd for UnifiedNum

fn checked_add(&self, v: &Self) -> Option<Self>

Adds two numbers, checking for overflow. If overflow happens, None is returned.

impl CheckedDiv for UnifiedNum

fn checked_div(&self, rhs: &Self) -> Option<Self>

Divides two numbers, checking for underflow, overflow and division by zero. If any of that happens, None is returned.

impl CheckedMul for UnifiedNum

fn checked_mul(&self, v: &Self) -> Option<Self>

Multiplies two numbers, checking for underflow or overflow. If underflow or overflow happens, None is returned.

impl CheckedRem for UnifiedNum

fn checked_rem(&self, v: &Self) -> Option<Self>

Finds the remainder of dividing two numbers, checking for underflow, overflow and division by zero. If any of that happens, None is returned.

impl CheckedSub for UnifiedNum

fn checked_sub(&self, v: &Self) -> Option<Self>

Subtracts two numbers, checking for underflow. If underflow happens, None is returned.

impl Clone for UnifiedNum

fn clone(&self) -> UnifiedNum

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UnifiedNum

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

Formats the value using the given formatter.

impl Default for UnifiedNum

fn default() -> UnifiedNum

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for UnifiedNum

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for UnifiedNum

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

Formats the value using the given formatter.

impl Div<&UnifiedNum> for &UnifiedNum

type Output = UnifiedNum

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<&UnifiedNum> for UnifiedNum

type Output = UnifiedNum

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<UnifiedNum> for UnifiedNum

type Output = UnifiedNum

The resulting type after applying the / operator.

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

Performs the / operation.

impl From<UnifiedNum> for String

fn from(unified_num: UnifiedNum) -> Self

Converts to this type from the input type.

impl From<u64> for UnifiedNum

fn from(number: u64) -> Self

Converts to this type from the input type.

impl FromPrimitive for UnifiedNum

fn from_i64(n: i64) -> Option<Self>

Converts an i64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u64(n: u64) -> Option<Self>

Converts an u64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_isize(n: isize) -> Option<Self>

Converts an isize to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i8(n: i8) -> Option<Self>

Converts an i8 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i16(n: i16) -> Option<Self>

Converts an i16 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i32(n: i32) -> Option<Self>

Converts an i32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i128(n: i128) -> Option<Self>

Converts an i128 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_usize(n: usize) -> Option<Self>

Converts a usize to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u8(n: u8) -> Option<Self>

Converts an u8 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u16(n: u16) -> Option<Self>

Converts an u16 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u32(n: u32) -> Option<Self>

Converts an u32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u128(n: u128) -> Option<Self>

Converts an u128 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_f32(n: f32) -> Option<Self>

Converts a f32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_f64(n: f64) -> Option<Self>

Converts a f64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

impl<'a> FromSql<'a> for UnifiedNum

fn from_sql(
    ty: &Type,
    raw: &'a [u8]
) -> Result<UnifiedNum, Box<dyn Error + Sync + Send>>

Creates a new value of this type from a buffer of data of the specified Postgres Type in its binary format.

fn accepts(ty: &Type) -> bool

Determines if a value of this type can be created from the specified Postgres Type.

fn from_sql_null(
    ty: &Type
) -> Result<Self, Box<dyn Error + Sync + Send + 'static, Global>>

Creates a new value of this type from a NULL SQL value.

fn from_sql_nullable(
    ty: &Type,
    raw: Option<&'a [u8]>
) -> Result<Self, Box<dyn Error + Sync + Send + 'static, Global>>

A convenience function that delegates to from_sql and from_sql_null depending on the value of raw.

impl FromStr for UnifiedNum

type Err = ParseError

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 FromWhole<f64> for UnifiedNum

fn from_whole(number: f64) -> Self

Panics

fn from_whole_opt(number: f64) -> Option<Self>

Same as Self::from_whole but instead of panicking it returns an Option.

impl FromWhole<u64> for UnifiedNum

fn from_whole(whole_number: u64) -> Self

Panics

fn from_whole_opt(whole_number: u64) -> Option<Self>

Same as Self::from_whole but instead of panicking it returns an Option.

impl Hash for UnifiedNum

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 Integer for UnifiedNum

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

Floored integer division.

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

Floored integer modulo, satisfying:

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

Greatest Common Divisor (GCD).

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

Lowest Common Multiple (LCM).

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

Deprecated, use is_multiple_of instead.

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

Returns true if self is a multiple of other.

fn is_even(&self) -> bool

Returns true if the number is even.

fn is_odd(&self) -> bool

Returns true if the number is odd.

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

Simultaneous truncated integer division and modulus. Returns (quotient, remainder).

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

Ceiled integer division.

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

Greatest Common Divisor (GCD) and Lowest Common Multiple (LCM) together.

fn extended_gcd(&self, other: &Self) -> ExtendedGcd<Self>where
    Self: Clone,

Greatest common divisor and Bézout coefficients.

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

Simultaneous floored integer division and modulus. Returns (quotient, remainder).

fn next_multiple_of(&self, other: &Self) -> Selfwhere
    Self: Clone,

Rounds up to nearest multiple of argument.

fn prev_multiple_of(&self, other: &Self) -> Selfwhere
    Self: Clone,

Rounds down to nearest multiple of argument.

impl Mul<&UnifiedNum> for &UnifiedNum

type Output = UnifiedNum

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<&UnifiedNum> for UnifiedNum

type Output = UnifiedNum

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<UnifiedNum> for UnifiedNum

type Output = UnifiedNum

The resulting type after applying the * operator.

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

Performs the * operation.

impl Num for UnifiedNum

type FromStrRadixErr = <u64 as Num>::FromStrRadixErr

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

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

impl One for UnifiedNum

fn one() -> Self

1.00_000_000

fn set_one(&mut self)

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

fn is_one(&self) -> boolwhere
    Self: PartialEq<Self>,

Returns true if self is equal to the multiplicative identity.

impl Ord for UnifiedNum

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<UnifiedNum> for UnifiedNum

fn eq(&self, other: &UnifiedNum) -> 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 PartialOrd<UnifiedNum> for UnifiedNum

fn partial_cmp(&self, other: &UnifiedNum) -> 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 Rem<&UnifiedNum> for &UnifiedNum

type Output = UnifiedNum

The resulting type after applying the % operator.

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

Performs the % operation.

impl Rem<UnifiedNum> for UnifiedNum

type Output = UnifiedNum

The resulting type after applying the % operator.

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

Performs the % operation.

impl Serialize for UnifiedNum

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

Serialize this value into the given Serde serializer.

impl Sub<&UnifiedNum> for &UnifiedNum

type Output = UnifiedNum

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<&UnifiedNum> for UnifiedNum

type Output = UnifiedNum

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<UnifiedNum> for &UnifiedNum

type Output = UnifiedNum

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<UnifiedNum> for UnifiedNum

type Output = UnifiedNum

The resulting type after applying the - operator.

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

Performs the - operation.

impl<'a> Sum<&'a UnifiedNum> for BigNum

fn sum<I: Iterator<Item = &'a UnifiedNum>>(iter: I) -> BigNum

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

impl<'a> Sum<&'a UnifiedNum> for Option<UnifiedNum>

fn sum<I: Iterator<Item = &'a UnifiedNum>>(iter: I) -> Self

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

impl Sum<UnifiedNum> for Option<UnifiedNum>

fn sum<I: Iterator<Item = UnifiedNum>>(iter: I) -> Self

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

impl ToPrimitive for UnifiedNum

fn to_i64(&self) -> Option<i64>

Converts the value of self to an i64. If the value cannot be represented by an i64, then None is returned.

fn to_u64(&self) -> Option<u64>

Converts the value of self to a u64. If the value cannot be represented by a u64, then None is returned.

fn to_isize(&self) -> Option<isize>

Converts the value of self to an isize. If the value cannot be represented by an isize, then None is returned.

fn to_i8(&self) -> Option<i8>

Converts the value of self to an i8. If the value cannot be represented by an i8, then None is returned.

fn to_i16(&self) -> Option<i16>

Converts the value of self to an i16. If the value cannot be represented by an i16, then None is returned.

fn to_i32(&self) -> Option<i32>

Converts the value of self to an i32. If the value cannot be represented by an i32, then None is returned.

fn to_i128(&self) -> Option<i128>

Converts the value of self to an i128. If the value cannot be represented by an i128 (i64 under the default implementation), then None is returned.

fn to_usize(&self) -> Option<usize>

Converts the value of self to a usize. If the value cannot be represented by a usize, then None is returned.

fn to_u8(&self) -> Option<u8>

Converts the value of self to a u8. If the value cannot be represented by a u8, then None is returned.

fn to_u16(&self) -> Option<u16>

Converts the value of self to a u16. If the value cannot be represented by a u16, then None is returned.

fn to_u32(&self) -> Option<u32>

Converts the value of self to a u32. If the value cannot be represented by a u32, then None is returned.

fn to_u128(&self) -> Option<u128>

Converts the value of self to a u128. If the value cannot be represented by a u128 (u64 under the default implementation), then None is returned.

fn to_f32(&self) -> Option<f32>

Converts the value of self to an f32. Overflows may map to positive or negative inifinity, otherwise None is returned if the value cannot be represented by an f32.

fn to_f64(&self) -> Option<f64>

Converts the value of self to an f64. Overflows may map to positive or negative inifinity, otherwise None is returned if the value cannot be represented by an f64.

impl ToSql for UnifiedNum

fn to_sql(
    &self,
    ty: &Type,
    w: &mut BytesMut
) -> Result<IsNull, Box<dyn Error + Sync + Send>>

Converts the value of self into the binary format of the specified Postgres Type, appending it to out.

fn accepts(ty: &Type) -> bool

Determines if a value of this type can be converted to the specified Postgres Type.

fn to_sql_checked(
    &self,
    ty: &Type,
    out: &mut BytesMut
) -> Result<IsNull, Box<dyn Error + Sync + Send>>

An adaptor method used internally by Rust-Postgres.

fn encode_format(&self, _ty: &Type) -> Format

Specify the encode format

impl TryFrom<String> for UnifiedNum

type Error = ParseError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Value> for UnifiedNum

The UnifiedNum can be expressed in the DSL either with a String or UnifiedNum

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Zero for UnifiedNum

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.

impl Copy for UnifiedNum

impl Eq for UnifiedNum

impl StructuralEq for UnifiedNum

impl StructuralPartialEq for UnifiedNum