Struct Decimal

Source
pub struct Decimal { /* private fields */ }
Expand description

Decimal represents a 128 bit representation of a fixed-precision decimal number. The finite set of values of type Decimal are of the form m / 10e, where m is an integer such that -296 < m < 296, and e is an integer between 0 and 28 inclusive.

Implementations§

Source§

impl Decimal

Source

pub const MIN: Decimal = MIN

The smallest value that can be represented by this decimal type.

Source

pub const MAX: Decimal = MAX

The largest value that can be represented by this decimal type.

Source

pub const ZERO: Decimal = ZERO

A constant representing 0.

Source

pub const ONE: Decimal = ONE

A constant representing 1.

Source

pub fn new(num: i64, scale: u32) -> Decimal

Returns a Decimal with a 64 bit m representation and corresponding e scale.

§Arguments
  • num - An i64 that represents the m portion of the decimal number
  • scale - A u32 representing the e portion of the decimal number.
§Panics

This function panics if scale is > 28.

§Example
use rust_decimal::Decimal;

let pi = Decimal::new(3141, 3);
assert_eq!(pi.to_string(), "3.141");
Source

pub fn from_i128_with_scale(num: i128, scale: u32) -> Decimal

Creates a Decimal using a 128 bit signed m representation and corresponding e scale.

§Arguments
  • num - An i128 that represents the m portion of the decimal number
  • scale - A u32 representing the e portion of the decimal number.
§Panics

This function panics if scale is > 28 or if num exceeds the maximum supported 96 bits.

§Example
use rust_decimal::Decimal;

let pi = Decimal::from_i128_with_scale(3141i128, 3);
assert_eq!(pi.to_string(), "3.141");
Source

pub const fn from_parts( lo: u32, mid: u32, hi: u32, negative: bool, scale: u32, ) -> Decimal

Returns a Decimal using the instances constituent parts.

§Arguments
  • lo - The low 32 bits of a 96-bit integer.
  • mid - The middle 32 bits of a 96-bit integer.
  • hi - The high 32 bits of a 96-bit integer.
  • negative - true to indicate a negative number.
  • scale - A power of 10 ranging from 0 to 28.
§Caution: Undefined behavior

While a scale greater than 28 can be passed in, it will be automatically capped by this function at the maximum precision. The library opts towards this functionality as opposed to a panic to ensure that the function can be treated as constant. This may lead to undefined behavior in downstream applications and should be treated with caution.

§Example
use rust_decimal::Decimal;

let pi = Decimal::from_parts(1102470952, 185874565, 1703060790, false, 28);
assert_eq!(pi.to_string(), "3.1415926535897932384626433832");
Source

pub fn from_scientific(value: &str) -> Result<Decimal, Error>

Returns a Result which if successful contains the Decimal constitution of the scientific notation provided by value.

§Arguments
  • value - The scientific notation of the Decimal.
§Example
use rust_decimal::Decimal;

let value = Decimal::from_scientific("9.7e-7").unwrap();
assert_eq!(value.to_string(), "0.00000097");
Source

pub const fn scale(&self) -> u32

Returns the scale of the decimal number, otherwise known as e.

§Example
use rust_decimal::Decimal;

let num = Decimal::new(1234, 3);
assert_eq!(num.scale(), 3u32);
Source

pub const fn mantissa(&self) -> i128

Returns the mantissa of the decimal number.

§Example
use rust_decimal::prelude::*;

let num = Decimal::from_str("-1.2345678").unwrap();
assert_eq!(num.mantissa(), -12345678i128);
assert_eq!(num.scale(), 7);
Source

pub const fn is_zero(&self) -> bool

Returns true if this Decimal number is equivalent to zero.

§Example
use rust_decimal::prelude::*;

let num = Decimal::ZERO;
assert!(num.is_zero());
Source

pub fn set_sign(&mut self, positive: bool)

👎Deprecated since 1.4.0: please use set_sign_positive instead

An optimized method for changing the sign of a decimal number.

§Arguments
  • positive: true if the resulting decimal should be positive.
§Example
use rust_decimal::Decimal;

let mut one = Decimal::new(1, 0);
one.set_sign(false);
assert_eq!(one.to_string(), "-1");
Source

pub fn set_sign_positive(&mut self, positive: bool)

An optimized method for changing the sign of a decimal number.

§Arguments
  • positive: true if the resulting decimal should be positive.
§Example
use rust_decimal::Decimal;

let mut one = Decimal::new(1, 0);
one.set_sign_positive(false);
assert_eq!(one.to_string(), "-1");
Source

pub fn set_sign_negative(&mut self, negative: bool)

An optimized method for changing the sign of a decimal number.

§Arguments
  • negative: true if the resulting decimal should be negative.
§Example
use rust_decimal::Decimal;

let mut one = Decimal::new(1, 0);
one.set_sign_negative(true);
assert_eq!(one.to_string(), "-1");
Source

pub fn set_scale(&mut self, scale: u32) -> Result<(), Error>

An optimized method for changing the scale of a decimal number.

§Arguments
  • scale: the new scale of the number
§Example
use rust_decimal::Decimal;

let mut one = Decimal::new(1, 0);
one.set_scale(5).unwrap();
assert_eq!(one.to_string(), "0.00001");
Source

pub fn rescale(&mut self, scale: u32)

Modifies the Decimal to the given scale, attempting to do so without changing the underlying number itself.

Note that setting the scale to something less then the current Decimals scale will cause the newly created Decimal to have some rounding. Scales greater than the maximum precision supported by Decimal will be automatically rounded to Decimal::MAX_PRECISION. Rounding leverages the half up strategy.

§Arguments
  • scale: The scale to use for the new Decimal number.
§Example
use rust_decimal::Decimal;

let mut number = Decimal::new(1_123, 3);
number.rescale(6);
assert_eq!(number, Decimal::new(1_123_000, 6));
let mut round = Decimal::new(145, 2);
round.rescale(1);
assert_eq!(round, Decimal::new(15, 1));
Source

pub const fn serialize(&self) -> [u8; 16]

Returns a serialized version of the decimal number. The resulting byte array will have the following representation:

  • Bytes 1-4: flags
  • Bytes 5-8: lo portion of m
  • Bytes 9-12: mid portion of m
  • Bytes 13-16: high portion of m
Source

pub const fn deserialize(bytes: [u8; 16]) -> Decimal

Deserializes the given bytes into a decimal number. The deserialized byte representation must be 16 bytes and adhere to the following convention:

  • Bytes 1-4: flags
  • Bytes 5-8: lo portion of m
  • Bytes 9-12: mid portion of m
  • Bytes 13-16: high portion of m
Source

pub fn is_negative(&self) -> bool

👎Deprecated since 0.6.3: please use is_sign_negative instead

Returns true if the decimal is negative.

Source

pub fn is_positive(&self) -> bool

👎Deprecated since 0.6.3: please use is_sign_positive instead

Returns true if the decimal is positive.

Source

pub const fn is_sign_negative(&self) -> bool

Returns true if the sign bit of the decimal is negative.

Source

pub const fn is_sign_positive(&self) -> bool

Returns true if the sign bit of the decimal is positive.

Source

pub const fn min_value() -> Decimal

👎Deprecated since 1.12.0: Use the associated constant Decimal::MIN

Returns the minimum possible number that Decimal can represent.

Source

pub const fn max_value() -> Decimal

👎Deprecated since 1.12.0: Use the associated constant Decimal::MAX

Returns the maximum possible number that Decimal can represent.

Source

pub fn trunc(&self) -> Decimal

Returns a new Decimal integral with no fractional portion. This is a true truncation whereby no rounding is performed.

§Example
use rust_decimal::Decimal;

let pi = Decimal::new(3141, 3);
let trunc = Decimal::new(3, 0);
// note that it returns a decimal
assert_eq!(pi.trunc(), trunc);
Source

pub fn fract(&self) -> Decimal

Returns a new Decimal representing the fractional portion of the number.

§Example
use rust_decimal::Decimal;

let pi = Decimal::new(3141, 3);
let fract = Decimal::new(141, 3);
// note that it returns a decimal
assert_eq!(pi.fract(), fract);
Source

pub fn abs(&self) -> Decimal

Computes the absolute value of self.

§Example
use rust_decimal::Decimal;

let num = Decimal::new(-3141, 3);
assert_eq!(num.abs().to_string(), "3.141");
Source

pub fn floor(&self) -> Decimal

Returns the largest integer less than or equal to a number.

§Example
use rust_decimal::Decimal;

let num = Decimal::new(3641, 3);
assert_eq!(num.floor().to_string(), "3");
Source

pub fn ceil(&self) -> Decimal

Returns the smallest integer greater than or equal to a number.

§Example
use rust_decimal::Decimal;

let num = Decimal::new(3141, 3);
assert_eq!(num.ceil().to_string(), "4");
let num = Decimal::new(3, 0);
assert_eq!(num.ceil().to_string(), "3");
Source

pub fn max(self, other: Decimal) -> Decimal

Returns the maximum of the two numbers.

use rust_decimal::Decimal;

let x = Decimal::new(1, 0);
let y = Decimal::new(2, 0);
assert_eq!(y, x.max(y));
Source

pub fn min(self, other: Decimal) -> Decimal

Returns the minimum of the two numbers.

use rust_decimal::Decimal;

let x = Decimal::new(1, 0);
let y = Decimal::new(2, 0);
assert_eq!(x, x.min(y));
Source

pub fn normalize(&self) -> Decimal

Strips any trailing zero’s from a Decimal and converts -0 to 0.

§Example
use rust_decimal::Decimal;

let number = Decimal::new(3100, 3);
// note that it returns a decimal, without the extra scale
assert_eq!(number.normalize().to_string(), "3.1");
Source

pub fn round(&self) -> Decimal

Returns a new Decimal number with no fractional portion (i.e. an integer). Rounding currently follows “Bankers Rounding” rules. e.g. 6.5 -> 6, 7.5 -> 8

§Example
use rust_decimal::Decimal;

// Demonstrating bankers rounding...
let number_down = Decimal::new(65, 1);
let number_up   = Decimal::new(75, 1);
assert_eq!(number_down.round().to_string(), "6");
assert_eq!(number_up.round().to_string(), "8");
Source

pub fn round_dp_with_strategy( &self, dp: u32, strategy: RoundingStrategy, ) -> Decimal

Returns a new Decimal number with the specified number of decimal points for fractional portion. Rounding is performed using the provided RoundingStrategy

§Arguments
  • dp: the number of decimal points to round to.
  • strategy: the RoundingStrategy to use.
§Example
use rust_decimal::{Decimal, RoundingStrategy};
use core::str::FromStr;

let tax = Decimal::from_str("3.4395").unwrap();
assert_eq!(tax.round_dp_with_strategy(2, RoundingStrategy::MidpointAwayFromZero).to_string(), "3.44");
Source

pub fn round_dp(&self, dp: u32) -> Decimal

Returns a new Decimal number with the specified number of decimal points for fractional portion. Rounding currently follows “Bankers Rounding” rules. e.g. 6.5 -> 6, 7.5 -> 8

§Arguments
  • dp: the number of decimal points to round to.
§Example
use rust_decimal::Decimal;
use core::str::FromStr;

let pi = Decimal::from_str("3.1415926535897932384626433832").unwrap();
assert_eq!(pi.round_dp(2).to_string(), "3.14");
Source

pub const fn unpack(&self) -> UnpackedDecimal

Convert Decimal to an internal representation of the underlying struct. This is useful for debugging the internal state of the object.

§Important Disclaimer

This is primarily intended for library maintainers. The internal representation of a Decimal is considered “unstable” for public use.

§Example
use rust_decimal::Decimal;
use core::str::FromStr;

let pi = Decimal::from_str("3.1415926535897932384626433832").unwrap();
assert_eq!(format!("{:?}", pi), "3.1415926535897932384626433832");
assert_eq!(format!("{:?}", pi.unpack()), "UnpackedDecimal { \
    negative: false, scale: 28, hi: 1703060790, mid: 185874565, lo: 1102470952 \
}");
Source

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

Checked addition. Computes self + other, returning None if overflow occurred.

Source

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

Checked subtraction. Computes self - other, returning None if overflow occurred.

Source

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

Checked multiplication. Computes self * other, returning None if overflow occurred.

Source

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

Checked division. Computes self / other, returning None if other == 0.0 or the division results in overflow.

Source

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

Checked remainder. Computes self % other, returning None if other == 0.0.

Source

pub fn from_str_radix(str: &str, radix: u32) -> Result<Decimal, Error>

Trait Implementations§

Source§

impl<'a, 'b> Add<&'b Decimal> for &'a Decimal

Source§

type Output = Decimal

The resulting type after applying the + operator.
Source§

fn add(self, other: &Decimal) -> Decimal

Performs the + operation. Read more
Source§

impl<'a> Add<&'a Decimal> for Decimal

Source§

type Output = Decimal

The resulting type after applying the + operator.
Source§

fn add(self, other: &Decimal) -> Decimal

Performs the + operation. Read more
Source§

impl<'a> Add<Decimal> for &'a Decimal

Source§

type Output = Decimal

The resulting type after applying the + operator.
Source§

fn add(self, other: Decimal) -> Decimal

Performs the + operation. Read more
Source§

impl Add for Decimal

Source§

type Output = Decimal

The resulting type after applying the + operator.
Source§

fn add(self, other: Decimal) -> Decimal

Performs the + operation. Read more
Source§

impl<'a> AddAssign<&'a Decimal> for &'a mut Decimal

Source§

fn add_assign(&mut self, other: &'a Decimal)

Performs the += operation. Read more
Source§

impl<'a> AddAssign<&'a Decimal> for Decimal

Source§

fn add_assign(&mut self, other: &'a Decimal)

Performs the += operation. Read more
Source§

impl<'a> AddAssign<Decimal> for &'a mut Decimal

Source§

fn add_assign(&mut self, other: Decimal)

Performs the += operation. Read more
Source§

impl AddAssign for Decimal

Source§

fn add_assign(&mut self, other: Decimal)

Performs the += operation. Read more
Source§

impl CheckedAdd for Decimal

Source§

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

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

impl CheckedDiv for Decimal

Source§

fn checked_div(&self, v: &Decimal) -> Option<Decimal>

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

impl CheckedMul for Decimal

Source§

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

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

impl CheckedRem for Decimal

Source§

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

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

impl CheckedSub for Decimal

Source§

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

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

impl Clone for Decimal

Source§

fn clone(&self) -> Decimal

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Decimal

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Decimal

Source§

fn default() -> Decimal

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for Decimal

Source§

fn deserialize<D>( deserializer: D, ) -> Result<Decimal, <D as Deserializer<'de>>::Error>
where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Display for Decimal

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'a, 'b> Div<&'b Decimal> for &'a Decimal

Source§

type Output = Decimal

The resulting type after applying the / operator.
Source§

fn div(self, other: &Decimal) -> Decimal

Performs the / operation. Read more
Source§

impl<'a> Div<&'a Decimal> for Decimal

Source§

type Output = Decimal

The resulting type after applying the / operator.
Source§

fn div(self, other: &Decimal) -> Decimal

Performs the / operation. Read more
Source§

impl<'a> Div<Decimal> for &'a Decimal

Source§

type Output = Decimal

The resulting type after applying the / operator.
Source§

fn div(self, other: Decimal) -> Decimal

Performs the / operation. Read more
Source§

impl Div for Decimal

Source§

type Output = Decimal

The resulting type after applying the / operator.
Source§

fn div(self, other: Decimal) -> Decimal

Performs the / operation. Read more
Source§

impl<'a> DivAssign<&'a Decimal> for &'a mut Decimal

Source§

fn div_assign(&mut self, other: &'a Decimal)

Performs the /= operation. Read more
Source§

impl<'a> DivAssign<&'a Decimal> for Decimal

Source§

fn div_assign(&mut self, other: &'a Decimal)

Performs the /= operation. Read more
Source§

impl<'a> DivAssign<Decimal> for &'a mut Decimal

Source§

fn div_assign(&mut self, other: Decimal)

Performs the /= operation. Read more
Source§

impl DivAssign for Decimal

Source§

fn div_assign(&mut self, other: Decimal)

Performs the /= operation. Read more
Source§

impl From<i128> for Decimal

Source§

fn from(t: i128) -> Decimal

Converts to this type from the input type.
Source§

impl From<i16> for Decimal

Source§

fn from(t: i16) -> Decimal

Converts to this type from the input type.
Source§

impl From<i32> for Decimal

Source§

fn from(t: i32) -> Decimal

Converts to this type from the input type.
Source§

impl From<i64> for Decimal

Source§

fn from(t: i64) -> Decimal

Converts to this type from the input type.
Source§

impl From<i8> for Decimal

Source§

fn from(t: i8) -> Decimal

Converts to this type from the input type.
Source§

impl From<isize> for Decimal

Source§

fn from(t: isize) -> Decimal

Converts to this type from the input type.
Source§

impl From<u128> for Decimal

Source§

fn from(t: u128) -> Decimal

Converts to this type from the input type.
Source§

impl From<u16> for Decimal

Source§

fn from(t: u16) -> Decimal

Converts to this type from the input type.
Source§

impl From<u32> for Decimal

Source§

fn from(t: u32) -> Decimal

Converts to this type from the input type.
Source§

impl From<u64> for Decimal

Source§

fn from(t: u64) -> Decimal

Converts to this type from the input type.
Source§

impl From<u8> for Decimal

Source§

fn from(t: u8) -> Decimal

Converts to this type from the input type.
Source§

impl From<usize> for Decimal

Source§

fn from(t: usize) -> Decimal

Converts to this type from the input type.
Source§

impl FromPrimitive for Decimal

Source§

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.
Source§

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.
Source§

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.
Source§

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.
Source§

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.
Source§

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.
Source§

impl FromStr for Decimal

Source§

type Err = Error

The associated error which can be returned from parsing.
Source§

fn from_str(value: &str) -> Result<Decimal, <Decimal as FromStr>::Err>

Parses a string s to return a value of this type. Read more
Source§

impl Hash for Decimal

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl LowerExp for Decimal

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'a, 'b> Mul<&'b Decimal> for &'a Decimal

Source§

type Output = Decimal

The resulting type after applying the * operator.
Source§

fn mul(self, other: &Decimal) -> Decimal

Performs the * operation. Read more
Source§

impl<'a> Mul<&'a Decimal> for Decimal

Source§

type Output = Decimal

The resulting type after applying the * operator.
Source§

fn mul(self, other: &Decimal) -> Decimal

Performs the * operation. Read more
Source§

impl<'a> Mul<Decimal> for &'a Decimal

Source§

type Output = Decimal

The resulting type after applying the * operator.
Source§

fn mul(self, other: Decimal) -> Decimal

Performs the * operation. Read more
Source§

impl Mul for Decimal

Source§

type Output = Decimal

The resulting type after applying the * operator.
Source§

fn mul(self, other: Decimal) -> Decimal

Performs the * operation. Read more
Source§

impl<'a> MulAssign<&'a Decimal> for &'a mut Decimal

Source§

fn mul_assign(&mut self, other: &'a Decimal)

Performs the *= operation. Read more
Source§

impl<'a> MulAssign<&'a Decimal> for Decimal

Source§

fn mul_assign(&mut self, other: &'a Decimal)

Performs the *= operation. Read more
Source§

impl<'a> MulAssign<Decimal> for &'a mut Decimal

Source§

fn mul_assign(&mut self, other: Decimal)

Performs the *= operation. Read more
Source§

impl MulAssign for Decimal

Source§

fn mul_assign(&mut self, other: Decimal)

Performs the *= operation. Read more
Source§

impl<'a> Neg for &'a Decimal

Source§

type Output = Decimal

The resulting type after applying the - operator.
Source§

fn neg(self) -> Decimal

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

Performs the unary - operation. Read more
Source§

impl Num for Decimal

Source§

type FromStrRadixErr = Error

Source§

fn from_str_radix( str: &str, radix: u32, ) -> Result<Decimal, <Decimal as Num>::FromStrRadixErr>

Convert from a string and radix (typically 2..=36). Read more
Source§

impl One for Decimal

Source§

fn one() -> Decimal

Returns the multiplicative identity element of Self, 1. Read more
Source§

fn set_one(&mut self)

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

fn is_one(&self) -> bool
where Self: PartialEq,

Returns true if self is equal to the multiplicative identity. 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,

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

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

Restrict a value to a certain interval. Read more
Source§

impl PartialEq for Decimal

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl PartialOrd for Decimal

Source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

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§

impl<'a, 'b> Rem<&'b Decimal> for &'a Decimal

Source§

type Output = Decimal

The resulting type after applying the % operator.
Source§

fn rem(self, other: &Decimal) -> Decimal

Performs the % operation. Read more
Source§

impl<'a> Rem<&'a Decimal> for Decimal

Source§

type Output = Decimal

The resulting type after applying the % operator.
Source§

fn rem(self, other: &Decimal) -> Decimal

Performs the % operation. Read more
Source§

impl<'a> Rem<Decimal> for &'a Decimal

Source§

type Output = Decimal

The resulting type after applying the % operator.
Source§

fn rem(self, other: Decimal) -> Decimal

Performs the % operation. Read more
Source§

impl Rem for Decimal

Source§

type Output = Decimal

The resulting type after applying the % operator.
Source§

fn rem(self, other: Decimal) -> Decimal

Performs the % operation. Read more
Source§

impl<'a> RemAssign<&'a Decimal> for &'a mut Decimal

Source§

fn rem_assign(&mut self, other: &'a Decimal)

Performs the %= operation. Read more
Source§

impl<'a> RemAssign<&'a Decimal> for Decimal

Source§

fn rem_assign(&mut self, other: &'a Decimal)

Performs the %= operation. Read more
Source§

impl<'a> RemAssign<Decimal> for &'a mut Decimal

Source§

fn rem_assign(&mut self, other: Decimal)

Performs the %= operation. Read more
Source§

impl RemAssign for Decimal

Source§

fn rem_assign(&mut self, other: Decimal)

Performs the %= operation. Read more
Source§

impl Serialize for Decimal

Source§

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl Signed for Decimal

Source§

fn abs(&self) -> Decimal

Computes the absolute value. Read more
Source§

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

The positive difference of two numbers. Read more
Source§

fn signum(&self) -> Decimal

Returns the sign of the number. Read more
Source§

fn is_positive(&self) -> bool

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

fn is_negative(&self) -> bool

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

impl<'a, 'b> Sub<&'b Decimal> for &'a Decimal

Source§

type Output = Decimal

The resulting type after applying the - operator.
Source§

fn sub(self, other: &Decimal) -> Decimal

Performs the - operation. Read more
Source§

impl<'a> Sub<&'a Decimal> for Decimal

Source§

type Output = Decimal

The resulting type after applying the - operator.
Source§

fn sub(self, other: &Decimal) -> Decimal

Performs the - operation. Read more
Source§

impl<'a> Sub<Decimal> for &'a Decimal

Source§

type Output = Decimal

The resulting type after applying the - operator.
Source§

fn sub(self, other: Decimal) -> Decimal

Performs the - operation. Read more
Source§

impl Sub for Decimal

Source§

type Output = Decimal

The resulting type after applying the - operator.
Source§

fn sub(self, other: Decimal) -> Decimal

Performs the - operation. Read more
Source§

impl<'a> SubAssign<&'a Decimal> for &'a mut Decimal

Source§

fn sub_assign(&mut self, other: &'a Decimal)

Performs the -= operation. Read more
Source§

impl<'a> SubAssign<&'a Decimal> for Decimal

Source§

fn sub_assign(&mut self, other: &'a Decimal)

Performs the -= operation. Read more
Source§

impl<'a> SubAssign<Decimal> for &'a mut Decimal

Source§

fn sub_assign(&mut self, other: Decimal)

Performs the -= operation. Read more
Source§

impl SubAssign for Decimal

Source§

fn sub_assign(&mut self, other: Decimal)

Performs the -= operation. Read more
Source§

impl<'a> Sum<&'a Decimal> for Decimal

Source§

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

Takes an iterator and generates Self from the elements by “summing up” the items.
Source§

impl Sum for Decimal

Source§

fn sum<I>(iter: I) -> Decimal
where I: Iterator<Item = Decimal>,

Takes an iterator and generates Self from the elements by “summing up” the items.
Source§

impl ToPrimitive for Decimal

Source§

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.
Source§

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. Read more
Source§

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.
Source§

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. Read more
Source§

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. Read more
Source§

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.
Source§

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.
Source§

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.
Source§

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.
Source§

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.
Source§

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.
Source§

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.
Source§

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.
Source§

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.
Source§

impl TryFrom<f32> for Decimal

Source§

type Error = Error

The type returned in the event of a conversion error.
Source§

fn try_from(value: f32) -> Result<Decimal, Error>

Performs the conversion.
Source§

impl TryFrom<f64> for Decimal

Source§

type Error = Error

The type returned in the event of a conversion error.
Source§

fn try_from(value: f64) -> Result<Decimal, Error>

Performs the conversion.
Source§

impl UpperExp for Decimal

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Zero for Decimal

Source§

fn zero() -> Decimal

Returns the additive identity element of Self, 0. Read more
Source§

fn is_zero(&self) -> bool

Returns true if self is equal to the additive identity.
Source§

fn set_zero(&mut self)

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

impl Copy for Decimal

Source§

impl Eq for Decimal

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CallHasher for T
where T: Hash + ?Sized,

Source§

default fn get_hash<H, B>(value: &H, build_hasher: &B) -> u64
where H: Hash + ?Sized, B: BuildHasher,

Source§

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

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> 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
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

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

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> NumAssign for T
where T: Num + NumAssignOps,

Source§

impl<T, Rhs> NumAssignOps<Rhs> for T
where T: AddAssign<Rhs> + SubAssign<Rhs> + MulAssign<Rhs> + DivAssign<Rhs> + RemAssign<Rhs>,

Source§

impl<T> NumAssignRef for T
where T: NumAssign + for<'r> NumAssignOps<&'r T>,

Source§

impl<T, Rhs, Output> NumOps<Rhs, Output> for T
where T: Sub<Rhs, Output = Output> + Mul<Rhs, Output = Output> + Div<Rhs, Output = Output> + Add<Rhs, Output = Output> + Rem<Rhs, Output = Output>,

Source§

impl<T> NumRef for T
where T: Num + for<'r> NumOps<&'r T>,

Source§

impl<T, Base> RefNum<Base> for T
where T: NumOps<Base, Base> + for<'r> NumOps<&'r Base, Base>,