Struct BigDecimalRef

pub struct BigDecimalRef<'a> { /* private fields */ }

Immutable big-decimal, referencing a borrowed buffer of digits

The non-digit information like scale and sign may be changed on these objects, which otherwise would require cloning the full digit buffer in the BigDecimal.

Built from full BigDecimal object using the to_ref() method. BigDecimal not implement AsRef, so we will reserve the method as_ref() for a later time.

May be transformed into full BigDecimal object using the to_owned() method. This clones the bigdecimal digits.

BigDecimalRef (or Into<BigDecimalRef>) should be preferred over using &BigDecimal for library functions that need an immutable reference to a bigdecimal, as it may be much more efficient.

NOTE: Using &BigDecimalRef is redundant, and not recommended.

Examples

fn add_one<'a, N: Into<BigDecimalRef<'a>>>(n: N) -> BigDecimal {
    n.into() + 1
}

let n: BigDecimal = "123.456".parse().unwrap();

// call via "standard" reference (implements Into)
let m = add_one(&n);
assert_eq!(m, "124.456".parse().unwrap());

// call by negating the reference (fast: no-digit cloning involved)
let m = add_one(n.to_ref().neg());
assert_eq!(m, "-122.456".parse().unwrap());

Implementations

impl BigDecimalRef<'_>

pub fn to_owned(&self) -> BigDecimal

Clone digits to make this reference a full BigDecimal object

pub fn to_owned_with_scale(&self, scale: i64) -> BigDecimal

Clone digits, returning BigDecimal with given scale

let n: BigDecimal = "123.45678".parse().unwrap();
let r = n.to_ref();
assert_eq!(r.to_owned_with_scale(5), n.clone());
assert_eq!(r.to_owned_with_scale(0), "123".parse().unwrap());
assert_eq!(r.to_owned_with_scale(-1), "12e1".parse().unwrap());

let x = r.to_owned_with_scale(8);
assert_eq!(&x, &n);
assert_eq!(x.fractional_digit_count(), 8);

pub fn sign(&self) -> Sign

Sign of decimal

pub fn fractional_digit_count(&self) -> i64

Return number of digits ‘right’ of the decimal point (including leading zeros)

pub fn count_digits(&self) -> u64

Count total number of decimal digits

pub fn abs(&self) -> Self

Take absolute value of the decimal (non-negative sign)

pub fn round_with_context(&self, ctx: &Context) -> BigDecimal

Create BigDecimal from this reference, rounding to precision and with rounding-mode of the given context

pub fn sqrt_with_context(&self, ctx: &Context) -> Option<BigDecimal>

Take square root of this number

pub fn sqrt_abs_with_context(&self, ctx: &Context) -> BigDecimal

Take square root of absolute-value of the number

pub fn sqrt_copysign_with_context(&self, ctx: &Context) -> BigDecimal

Take square root, copying sign of the initial decimal

pub fn is_zero(&self) -> bool

Return if the referenced decimal is zero

pub fn clone_into(&self, dest: &mut BigDecimal)

Clone this value into dest

Trait Implementations

impl Add<&i128> for BigDecimalRef<'_>

type Output = BigDecimal

The resulting type after applying the + operator.

fn add(self, rhs: &i128) -> BigDecimal

Performs the + operation.

impl Add<&i16> for BigDecimalRef<'_>

type Output = BigDecimal

The resulting type after applying the + operator.

fn add(self, rhs: &i16) -> BigDecimal

Performs the + operation.

impl Add<&i32> for BigDecimalRef<'_>

type Output = BigDecimal

The resulting type after applying the + operator.

fn add(self, rhs: &i32) -> BigDecimal

Performs the + operation.

impl Add<&i64> for BigDecimalRef<'_>

type Output = BigDecimal

The resulting type after applying the + operator.

fn add(self, rhs: &i64) -> BigDecimal

Performs the + operation.

impl Add<&i8> for BigDecimalRef<'_>

type Output = BigDecimal

The resulting type after applying the + operator.

fn add(self, rhs: &i8) -> BigDecimal

Performs the + operation.

impl Add<&u128> for BigDecimalRef<'_>

type Output = BigDecimal

The resulting type after applying the + operator.

fn add(self, rhs: &u128) -> BigDecimal

Performs the + operation.

impl Add<&u16> for BigDecimalRef<'_>

type Output = BigDecimal

The resulting type after applying the + operator.

fn add(self, rhs: &u16) -> BigDecimal

Performs the + operation.

impl Add<&u32> for BigDecimalRef<'_>

type Output = BigDecimal

The resulting type after applying the + operator.

fn add(self, rhs: &u32) -> BigDecimal

Performs the + operation.

impl Add<&u64> for BigDecimalRef<'_>

type Output = BigDecimal

The resulting type after applying the + operator.

fn add(self, rhs: &u64) -> BigDecimal

Performs the + operation.

impl Add<&u8> for BigDecimalRef<'_>

type Output = BigDecimal

The resulting type after applying the + operator.

fn add(self, rhs: &u8) -> BigDecimal

Performs the + operation.

impl Add<BigDecimal> for BigDecimalRef<'_>

type Output = BigDecimal

The resulting type after applying the + operator.

fn add(self, rhs: BigDecimal) -> BigDecimal

Performs the + operation.

impl Add<BigDecimalRef<'_>> for &BigInt

type Output = BigDecimal

The resulting type after applying the + operator.

fn add(self, rhs: BigDecimalRef<'_>) -> BigDecimal

Performs the + operation.

impl Add<BigDecimalRef<'_>> for BigInt

type Output = BigDecimal

The resulting type after applying the + operator.

fn add(self, rhs: BigDecimalRef<'_>) -> BigDecimal

Performs the + operation.

impl Add<BigInt> for BigDecimalRef<'_>

type Output = BigDecimal

The resulting type after applying the + operator.

fn add(self, rhs: BigInt) -> BigDecimal

Performs the + operation.

impl<'a, T: Into<BigDecimalRef<'a>>> Add<T> for BigDecimalRef<'_>

type Output = BigDecimal

The resulting type after applying the + operator.

fn add(self, rhs: T) -> BigDecimal

Performs the + operation.

impl Add<i128> for BigDecimalRef<'_>

type Output = BigDecimal

The resulting type after applying the + operator.

fn add(self, rhs: i128) -> BigDecimal

Performs the + operation.

impl Add<i16> for BigDecimalRef<'_>

type Output = BigDecimal

The resulting type after applying the + operator.

fn add(self, rhs: i16) -> BigDecimal

Performs the + operation.

impl Add<i32> for BigDecimalRef<'_>

type Output = BigDecimal

The resulting type after applying the + operator.

fn add(self, rhs: i32) -> BigDecimal

Performs the + operation.

impl Add<i64> for BigDecimalRef<'_>

type Output = BigDecimal

The resulting type after applying the + operator.

fn add(self, rhs: i64) -> BigDecimal

Performs the + operation.

impl Add<i8> for BigDecimalRef<'_>

type Output = BigDecimal

The resulting type after applying the + operator.

fn add(self, rhs: i8) -> BigDecimal

Performs the + operation.

impl Add<u128> for BigDecimalRef<'_>

type Output = BigDecimal

The resulting type after applying the + operator.

fn add(self, rhs: u128) -> BigDecimal

Performs the + operation.

impl Add<u16> for BigDecimalRef<'_>

type Output = BigDecimal

The resulting type after applying the + operator.

fn add(self, rhs: u16) -> BigDecimal

Performs the + operation.

impl Add<u32> for BigDecimalRef<'_>

type Output = BigDecimal

The resulting type after applying the + operator.

fn add(self, rhs: u32) -> BigDecimal

Performs the + operation.

impl Add<u64> for BigDecimalRef<'_>

type Output = BigDecimal

The resulting type after applying the + operator.

fn add(self, rhs: u64) -> BigDecimal

Performs the + operation.

impl Add<u8> for BigDecimalRef<'_>

type Output = BigDecimal

The resulting type after applying the + operator.

fn add(self, rhs: u8) -> BigDecimal

Performs the + operation.

impl<'a> Clone for BigDecimalRef<'a>

fn clone(&self) -> BigDecimalRef<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for BigDecimalRef<'a>

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

Formats the value using the given formatter.

impl Display for BigDecimalRef<'_>

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

Formats the value using the given formatter.

impl<'a> From<&'a BigDecimal> for BigDecimalRef<'a>

fn from(n: &'a BigDecimal) -> Self

Converts to this type from the input type.

impl<'a> From<&'a BigInt> for BigDecimalRef<'a>

fn from(n: &'a BigInt) -> Self

Converts to this type from the input type.

impl LowerExp for BigDecimalRef<'_>

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

Formats the value using the given formatter.

impl Neg for BigDecimalRef<'_>

type Output = BigDecimalRef<'_>

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl Ord for BigDecimalRef<'_>

fn cmp(&self, other: &BigDecimalRef<'_>) -> Ordering

Complete ordering implementation for BigDecimal

Example

use std::str::FromStr;

let a = bigdecimal::BigDecimal::from_str("-1").unwrap();
let b = bigdecimal::BigDecimal::from_str("1").unwrap();
assert!(a < b);
assert!(b > a);
let c = bigdecimal::BigDecimal::from_str("1").unwrap();
assert!(b >= c);
assert!(c >= b);
let d = bigdecimal::BigDecimal::from_str("10.0").unwrap();
assert!(d > c);
let e = bigdecimal::BigDecimal::from_str(".5").unwrap();
assert!(e < c);

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<'rhs, T> PartialEq<T> for BigDecimalRef<'_>

where T: Into<BigDecimalRef<'rhs>> + Copy,

fn eq(&self, rhs: &T) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for BigDecimalRef<'_>

fn partial_cmp(&self, other: &BigDecimalRef<'_>) -> 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 Sub<BigDecimal> for BigDecimalRef<'_>

type Output = BigDecimal

The resulting type after applying the - operator.

fn sub(self, rhs: BigDecimal) -> BigDecimal

Performs the - operation.

impl<'a> Sub<BigDecimalRef<'a>> for &BigInt

type Output = BigDecimal

The resulting type after applying the - operator.

fn sub(self, rhs: BigDecimalRef<'a>) -> BigDecimal

Performs the - operation.

impl<'a> Sub<BigDecimalRef<'a>> for BigInt

type Output = BigDecimal

The resulting type after applying the - operator.

fn sub(self, rhs: BigDecimalRef<'a>) -> BigDecimal

Performs the - operation.

impl Sub<BigInt> for BigDecimalRef<'_>

type Output = BigDecimal

The resulting type after applying the - operator.

fn sub(self, rhs: BigInt) -> BigDecimal

Performs the - operation.

impl<'a, T: Into<BigDecimalRef<'a>>> Sub<T> for BigDecimalRef<'_>

type Output = BigDecimal

The resulting type after applying the - operator.

fn sub(self, rhs: T) -> BigDecimal

Performs the - operation.

impl ToPrimitive for BigDecimalRef<'_>

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_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_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_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_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.

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_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_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.

impl UpperExp for BigDecimalRef<'_>

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

Formats the value using the given formatter.

impl<'a> Copy for BigDecimalRef<'a>

impl<'a> Eq for BigDecimalRef<'a>