Struct ion_rs::types::decimal::Decimal

source · [−]

pub struct Decimal { /* private fields */ }

Expand description

An arbitrary-precision Decimal type with a distinct representation of negative zero (-0).

Implementations

impl Decimal

pub fn new<I: Into<Coefficient>>(coefficient: I, exponent: i64) -> Decimal

Constructs a new Decimal with the provided components. The value of the decimal is (coefficient * 10^exponent) * (if sign == Sign::Negative { -1 } else { 1 })

pub fn scale(&self) -> i64

Returns scale of the Decimal value If zero or positive, a scale indicates the number of digits to the right of the decimal point. If negative, the unscaled value of the number is multiplied by ten to the power of the negation of the scale. For example, a scale of -3 means the unscaled value is multiplied by 1000.

pub fn precision(&self) -> u64

Returns the number of digits in the non-scaled integer representation of the decimal.

pub fn negative_zero() -> Decimal

Constructs a Decimal with the value -0d0. This is provided as a convenience method because Rust will ignore a unary minus when it is applied to an zero literal (-0).

pub fn negative_zero_with_exponent(exponent: i64) -> Decimal

Constructs a Decimal with a coefficient of -0 and the specified exponent. This function is provided as a convenience method because Rust will ignore a unary minus when it is applied to a zero literal (-0).

pub fn is_zero(&self) -> bool

Returns true if this Decimal is a zero of any sign or exponent.

pub fn is_less_than_zero(&self) -> bool

Returns true if this Decimal’s coefficient has a negative sign AND a magnitude greater than zero. Otherwise, returns false. (Negative zero returns false.)

Trait Implementations

impl Clone for Decimal

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

impl Debug for Decimal

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

Formats the value using the given formatter. Read more

impl Display for Decimal

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

Formats the value using the given formatter. Read more

impl From<BigDecimal> for Decimal

Make a Decimal from a BigDecimal. This is a lossless operation.

fn from(value: BigDecimal) -> Self

Converts to this type from the input type.

impl<'val> From<Decimal> for BorrowedElement<'val>

fn from(decimal_val: Decimal) -> Self

Converts to this type from the input type.

impl From<Decimal> for OwnedElement

fn from(decimal_val: Decimal) -> Self

Converts to this type from the input type.

impl From<i16> for Decimal

fn from(value: i16) -> Self

Converts to this type from the input type.

impl From<i32> for Decimal

fn from(value: i32) -> Self

Converts to this type from the input type.

impl From<i64> for Decimal

fn from(value: i64) -> Self

Converts to this type from the input type.

impl From<i8> for Decimal

fn from(value: i8) -> Self

Converts to this type from the input type.

impl From<isize> for Decimal

fn from(value: isize) -> Self

Converts to this type from the input type.

impl From<u16> for Decimal

fn from(value: u16) -> Self

Converts to this type from the input type.

impl From<u32> for Decimal

fn from(value: u32) -> Self

Converts to this type from the input type.

impl From<u64> for Decimal

fn from(value: u64) -> Self

Converts to this type from the input type.

impl From<u8> for Decimal

fn from(value: u8) -> Self

Converts to this type from the input type.

impl From<usize> for Decimal

fn from(value: usize) -> Self

Converts to this type from the input type.

impl IonEq for Decimal

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

impl Ord for Decimal

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

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

1.21.0 · source

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

Compares and returns the maximum of two values. Read more

1.21.0 · source

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

Compares and returns the minimum of two values. Read more

1.50.0 · source

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

Restrict a value to a certain interval. Read more

impl PartialEq<Decimal> for Decimal

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

This method tests for self and other values to be equal, and is used by ==. Read more

1.0.0 · source

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

This method tests for !=.

impl PartialOrd<Decimal> for Decimal

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

This method 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

This method 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

This method 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

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

impl TryFrom<Decimal> for BigDecimal

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

Attempts to create a BigDecimal from a Decimal. Returns an Error if the Decimal being converted is a negative zero, which BigDecimal cannot represent. Returns Ok otherwise.

type Error = IonError

The type returned in the event of a conversion error.

impl TryFrom<f32> for Decimal

type Error = IonError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<f64> for Decimal

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

Attempts to create a Decimal from an f64. Returns an Error if the f64 being converted is a special value, including:

Infinity
Negative infinity
NaN (not-a-number) Otherwise, returns Ok.

Because Decimal can represent negative zero, f64::neg_zero() IS supported.

NOTE: While the resulting decimal will be a very close approximation of the original f64’s value, this is an inherently lossy operation. Floating point values do not encode a precision. When converting an f64 to a Decimal, a precision for the new Decimal must be chosen somewhat arbitrarily. Do NOT rely on the precision of the resulting Decimal. This implementation may change without notice.

type Error = IonError

The type returned in the event of a conversion error.

impl Eq for Decimal

Auto Trait Implementations

impl RefUnwindSafe for Decimal

impl Send for Decimal

impl Sync for Decimal

impl Unpin for Decimal

impl UnwindSafe for Decimal

Blanket Implementations

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

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

const: unstable · 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.

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

🔬 This is a nightly-only experimental API. (toowned_clone_into)

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

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

default fn to_string(&self) -> String

Converts the given value to a String. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.