Struct Number

Source

#[repr(C, packed(4))]
pub struct Number { /* private fields */ }

Expand description

High precision decimal.

Implementations§

Source §

impl Decimal

Source

pub const ZERO: Decimal

Zero value, i.e. 0.

Source

pub const ONE: Decimal

i.e. 1.

Source

pub const unsafe fn from_parts_unchecked( int_val: u128, scale: i16, negative: bool, ) -> Decimal

Creates a Decimal from parts without boundary checking.

§Safety

User have to guarantee that int_val has at most 38 tens digits and scale ranges from [-126, 130].

Source

pub const fn from_parts( int_val: u128, scale: i16, negative: bool, ) -> Result<Decimal, DecimalConvertError>

Creates a Decimal from parts.

Source

pub fn normalize_to_scale(&self, scale: i16) -> Decimal

Normalize a Decimal’s scale toward specified scale.

Source

pub fn normalize(&self) -> Decimal

Normalize a Decimal’s scale toward zero.

Source

pub fn checked_add(&self, other: impl AsRef<Decimal>) -> Option<Decimal>

Add two decimals. returning None if overflow occurred.

Source

pub unsafe fn add_with_same_scale_unchecked<const DECIMAL_MODEL: u8>( &self, other: &Decimal, scale: i16, ) -> Decimal

Add two decimals.

§Safety

Make sure the decimal is zero or the scale is the same and the result is not overflow.

Source

pub unsafe fn add_with_same_scale_and_negative_unchecked<const DECIMAL_MODEL: u8>( &self, other: &Decimal, scale: i16, negative: bool, ) -> Decimal

Add two decimals.

§Safety

Make sure the follow conditions

decimal is zero or the scale is the same.
the result is not overflow.
decimal is zero or the negative is the same.

Source

pub fn checked_sub(&self, other: impl AsRef<Decimal>) -> Option<Decimal>

Subtract one decimal from another, returning None if overflow occurred.

Source

pub unsafe fn sub_with_same_scale_unchecked<const DECIMAL_MODEL: u8>( &self, other: &Decimal, scale: i16, ) -> Decimal

Subtract one decimal from another,

§Safety

Make sure two decimal have the same scale or is zero and the result is not overflow.

Source

pub fn checked_mul(&self, other: impl AsRef<Decimal>) -> Option<Decimal>

Calculate the product of two decimals, returning None if overflow occurred.

Source

Formats the decimal in the json number format, using scientific notation depending on the width.

Source

pub fn checked_pow(&self, exponent: &Decimal) -> Option<Decimal>

Raise self to the power of exponent, where self and exponent are both decimal, returning None if self == 0 at the same time exponent is negative or self is negative at the same time exponent is a fraction or the result overflowed.

Source

pub fn ln(&self) -> Option<Decimal>

Computes the natural logarithm of self, returning None if self is negative or self == 0.

Source

pub fn exp(&self) -> Option<Decimal>

Computes the nature exponential of self, returning None if the result overflowed.

Performs the unary - operation. Read more

Source §

impl Neg for Decimal

Source §

type Output = Decimal

The resulting type after applying the - operator.

Source §

fn neg(self) -> <Decimal as Neg>::Output

Performs the unary - operation. Read more

Source §

impl Ord for Decimal

Source §

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

This method returns an Ordering between self and other. Read more

1.21.0 · Source§

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

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

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

1.0.0 · Source§

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

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

1.0.0 · Source§

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

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

Source §

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

Takes an iterator and generates Self from the elements by multiplying the items.

Source §

impl Copy for Decimal

Source §

impl Eq for Decimal

impl<T, U> Into for T
where U: From<T>,

Source §

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source §

impl<T> ToOwned for T
where T: Clone,

Source §

type Owned = T

The resulting type after obtaining ownership.

Source §

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

Performs the conversion.

Source §

impl<T, U> TryInto for T
where U: TryFrom<T>,

Source §

type Error = >::Error

The type returned in the event of a conversion error.

Source §

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct Number Copy item path

Implementations§

impl Decimal

pub const ZERO: Decimal

pub const ONE: Decimal

pub const unsafe fn from_parts_unchecked( int_val: u128, scale: i16, negative: bool, ) -> Decimal

§Safety

pub const fn from_parts( int_val: u128, scale: i16, negative: bool, ) -> Result<Decimal, DecimalConvertError>

pub const fn into_parts(self) -> (u128, i16, bool)

pub fn precision(&self) -> u8

pub const fn scale(&self) -> i16

pub const fn is_sign_negative(&self) -> bool

pub const fn is_sign_positive(&self) -> bool

pub const fn is_zero(&self) -> bool

pub const fn abs(&self) -> Decimal

pub fn encode<W>(&self, writer: W) -> Result<usize, Error>where W: Write,

pub fn compact_encode<W>(&self, writer: W) -> Result<usize, Error>where W: Write,

pub fn decode(bytes: &[u8]) -> Decimal

pub fn ceil(&self) -> Decimal

pub fn floor(&self) -> Decimal

pub fn trunc(&self, scale: i16) -> Decimal

pub fn round(&self, scale: i16) -> Decimal

pub fn round_with_precision(&mut self, precision: u8, scale: i16) -> bool

pub fn normalize_to_scale(&self, scale: i16) -> Decimal

pub fn normalize(&self) -> Decimal

pub fn checked_add(&self, other: impl AsRef<Decimal>) -> Option<Decimal>

pub unsafe fn add_with_same_scale_unchecked<const DECIMAL_MODEL: u8>( &self, other: &Decimal, scale: i16, ) -> Decimal

§Safety

pub unsafe fn add_with_same_scale_and_negative_unchecked<const DECIMAL_MODEL: u8>( &self, other: &Decimal, scale: i16, negative: bool, ) -> Decimal

§Safety

pub fn checked_sub(&self, other: impl AsRef<Decimal>) -> Option<Decimal>

pub unsafe fn sub_with_same_scale_unchecked<const DECIMAL_MODEL: u8>( &self, other: &Decimal, scale: i16, ) -> Decimal

§Safety

pub fn checked_mul(&self, other: impl AsRef<Decimal>) -> Option<Decimal>

pub unsafe fn mul_unchecked<const DECIMAL_MODEL: u8>( &self, other: &Decimal, scale: i16, ) -> Decimal

§Safety

pub fn checked_div(&self, other: impl AsRef<Decimal>) -> Option<Decimal>

pub fn checked_rem(&self, other: impl AsRef<Decimal>) -> Option<Decimal>

pub fn sqrt(&self) -> Option<Decimal>

pub fn simply_format<W>(&self, w: W) -> Result<(), DecimalFormatError>where W: Write,

pub fn format_with_sci<W>( &self, max_width: u16, w: W, ) -> Result<(), DecimalFormatError>where W: Write,

pub fn format_with_sci_forced<W>( &self, expect_scale: i16, with_zero_before_dot: bool, w: W, ) -> Result<(), DecimalFormatError>where W: Write,

pub fn format_to_hex<W>( &self, is_uppercase: bool, w: W, ) -> Result<(), DecimalFormatError>where W: Write,

pub fn format_to_json<W>(&self, w: W) -> Result<(), DecimalFormatError>where W: Write,

pub fn checked_pow(&self, exponent: &Decimal) -> Option<Decimal>

pub fn ln(&self) -> Option<Decimal>

pub fn exp(&self) -> Option<Decimal>

Trait Implementations§

impl Add<&Decimal> for &Decimal

type Output = Decimal

fn add(self, other: &Decimal) -> <&Decimal as Add<&Decimal>>::Output

impl Add<&Decimal> for Decimal

type Output = Decimal

fn add(self, other: &Decimal) -> <Decimal as Add<&Decimal>>::Output

impl Add<Decimal> for &Decimal

type Output = Decimal

fn add(self, other: Decimal) -> <&Decimal as Add<Decimal>>::Output

impl Add<f32> for &Decimal

type Output = Decimal

fn add(self, other: f32) -> <&Decimal as Add<f32>>::Output

impl Add<f32> for Decimal

type Output = Decimal

fn add(self, other: f32) -> <Decimal as Add<f32>>::Output

impl Add<f64> for &Decimal

type Output = Decimal

fn add(self, other: f64) -> <&Decimal as Add<f64>>::Output

impl Add<f64> for Decimal

type Output = Decimal

fn add(self, other: f64) -> <Decimal as Add<f64>>::Output

impl Add<i128> for &Decimal

type Output = Decimal

fn add(self, other: i128) -> <&Decimal as Add<i128>>::Output

impl Add<i128> for Decimal

type Output = Decimal

fn add(self, other: i128) -> <Decimal as Add<i128>>::Output

impl Add<i16> for &Decimal

type Output = Decimal

fn add(self, other: i16) -> <&Decimal as Add<i16>>::Output

impl Add<i16> for Decimal

type Output = Decimal

Struct Number

pub fn encode<W>(&self, writer: W) -> Result<usize, Error>
where W: Write,

pub fn compact_encode<W>(&self, writer: W) -> Result<usize, Error>
where W: Write,

pub fn simply_format<W>(&self, w: W) -> Result<(), DecimalFormatError>
where W: Write,

pub fn format_with_sci<W>( &self, max_width: u16, w: W, ) -> Result<(), DecimalFormatError>
where W: Write,

pub fn format_with_sci_forced<W>( &self, expect_scale: i16, with_zero_before_dot: bool, w: W, ) -> Result<(), DecimalFormatError>
where W: Write,

pub fn format_to_hex<W>( &self, is_uppercase: bool, w: W, ) -> Result<(), DecimalFormatError>
where W: Write,

pub fn format_to_json<W>(&self, w: W) -> Result<(), DecimalFormatError>
where W: Write,