Struct Decimal 

pub struct Decimal(/* private fields */);

Decimal

Implementations

impl Decimal

pub const ZERO: Decimal

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

Construct a decimal from mantissa and scale.

pub fn from_num<N>(n: N) -> Option<Decimal>

where N: NumCast,

Fallible conversion from common numeric types.

pub const fn parts(&self) -> DecimalParts

PARTS

Decompose into mantissa and scale.

pub const fn is_integer(&self) -> bool

Returns true if the decimal has no fractional component.

pub fn scale_to_integer(&self, target_scale: u32) -> Option<i128>

Scale by 10^target_scale and require an integer result.

Returns None if:

• fractional precision would be lost
• integer overflow occurs

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

WRAPPED FUNCTIONS

Round to a given number of decimal places.

pub fn abs(&self) -> Decimal

Return the absolute value of the decimal.

pub fn saturating_add(self, rhs: Decimal) -> Decimal

Saturating addition.

pub fn saturating_sub(self, rhs: Decimal) -> Decimal

Saturating subtraction.

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

Checked remainder; returns None on division by zero.

pub fn powu(&self, exp: u64) -> Decimal

Integer exponentiation.

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

Build from a raw mantissa and scale.

pub fn normalize(&self) -> Decimal

Normalize trailing zeros.

pub const fn is_sign_negative(&self) -> bool

Returns true if the value is negative.

pub const fn scale(&self) -> u32

Returns the number of fractional decimal places.

pub const fn mantissa(&self) -> i128

Returns the mantissa component.

pub const fn is_zero(&self) -> bool

Returns true if the value is zero.

Trait Implementations

impl Add<Decimal> for Usd

type Output = Usd

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<Usd> for Decimal

type Output = Usd

The resulting type after applying the + operator.

fn add(self, other: Usd) -> Self::Output

Performs the + operation.

impl Add for Decimal

type Output = Decimal

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<Decimal> for Usd

fn add_assign(&mut self, other: Decimal)

Performs the += operation.

impl AddAssign for Decimal

fn add_assign(&mut self, __rhs: Decimal)

Performs the += operation.

impl AsView for Decimal

type ViewType = Decimal

fn as_view(&self) -> <Decimal as AsView>::ViewType

fn from_view(view: <Decimal as AsView>::ViewType) -> Decimal

impl CandidType for Decimal

fn _ty() -> Type

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

where S: Serializer,

fn ty() -> Type

fn id() -> TypeId

impl Clone for Decimal

fn clone(&self) -> Decimal

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Decimal

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

Formats the value using the given formatter.

impl Default for Decimal

fn default() -> Decimal

Returns the “default value” for a type.

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

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Decimal

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

Formats the value using the given formatter.

impl<D> Div<D> for Decimal

where D: Into<Decimal>,

type Output = Decimal

The resulting type after applying the / operator.

fn div(self, d: D) -> <Decimal as Div<D>>::Output

Performs the / operation.

impl Div<Decimal> for Usd

type Output = Usd

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<Usd> for Decimal

type Output = Usd

The resulting type after applying the / operator.

fn div(self, other: Usd) -> Self::Output

Performs the / operation.

impl<D> DivAssign<D> for Decimal

where D: Into<Decimal>,

fn div_assign(&mut self, d: D)

Performs the /= operation.

impl DivAssign<Decimal> for Usd

fn div_assign(&mut self, other: Decimal)

Performs the /= operation.

impl FieldValue for Decimal

fn kind() -> FieldValueKind

fn to_value(&self) -> Value

fn from_value(value: &Value) -> Option<Decimal>

impl From<Decimal> for Decimal

fn from(d: Decimal) -> Decimal

Converts to this type from the input type.

impl From<Decimal> for Value

fn from(v: Decimal) -> Value

Converts to this type from the input type.

impl From<E8s> for Decimal

fn from(v: E8s) -> Decimal

Converts to this type from the input type.

impl From<f32> for Decimal

fn from(n: f32) -> Decimal

Converts to this type from the input type.

impl From<f64> for Decimal

fn from(n: f64) -> Decimal

Converts to this type from the input type.

impl From<i128> for Decimal

fn from(n: i128) -> Decimal

Converts to this type from the input type.

impl From<i16> for Decimal

fn from(n: i16) -> Decimal

Converts to this type from the input type.

impl From<i32> for Decimal

fn from(n: i32) -> Decimal

Converts to this type from the input type.

impl From<i64> for Decimal

fn from(n: i64) -> Decimal

Converts to this type from the input type.

impl From<i8> for Decimal

fn from(n: i8) -> Decimal

Converts to this type from the input type.

impl From<u128> for Decimal

fn from(n: u128) -> Decimal

Converts to this type from the input type.

impl From<u16> for Decimal

fn from(n: u16) -> Decimal

Converts to this type from the input type.

impl From<u32> for Decimal

fn from(n: u32) -> Decimal

Converts to this type from the input type.

impl From<u64> for Decimal

fn from(n: u64) -> Decimal

Converts to this type from the input type.

impl From<u8> for Decimal

fn from(n: u8) -> Decimal

Converts to this type from the input type.

impl FromPrimitive for Decimal

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.

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.

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.

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.

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.

impl FromStr for Decimal

type Err = <Decimal as FromStr>::Err

The associated error which can be returned from parsing.

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

Parses a string s to return a value of this type.

impl Hash for Decimal

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

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 Inner<Decimal> for Usd

fn inner(&self) -> &Decimal

fn into_inner(self) -> Decimal

impl<D> Mul<D> for Decimal

where D: Into<Decimal>,

type Output = Decimal

The resulting type after applying the * operator.

fn mul(self, d: D) -> <Decimal as Mul<D>>::Output

Performs the * operation.

impl Mul<Decimal> for Usd

type Output = Usd

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Usd> for Decimal

type Output = Usd

The resulting type after applying the * operator.

fn mul(self, other: Usd) -> Self::Output

Performs the * operation.

impl<D> MulAssign<D> for Decimal

where D: Into<Decimal>,

fn mul_assign(&mut self, d: D)

Performs the *= operation.

impl MulAssign<Decimal> for Usd

fn mul_assign(&mut self, other: Decimal)

Performs the *= operation.

impl NumCast for Decimal

fn from<T>(n: T) -> Option<Decimal>

where T: ToPrimitive,

Creates a number from another value that can be converted into a primitive via the ToPrimitive trait. If the source value cannot be represented by the target type, then None is returned.

impl Ord for Decimal

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

This method returns an Ordering between self and other.

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 PartialEq<Decimal> for Decimal

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

fn eq(&self, other: &Decimal) -> 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 PartialEq<Decimal> for Usd

fn eq(&self, other: &Decimal) -> 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 PartialEq<Usd> for Decimal

fn eq(&self, other: &Usd) -> 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 PartialEq for Decimal

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

fn partial_cmp(&self, other: &Decimal) -> 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 PartialOrd<Decimal> for Usd

fn partial_cmp(&self, other: &Decimal) -> 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 PartialOrd<Usd> for Decimal

fn partial_cmp(&self, other: &Usd) -> 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 PartialOrd for Decimal

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

where D: Into<Decimal>,

type Output = Decimal

The resulting type after applying the % operator.

fn rem(self, d: D) -> <Decimal as Rem<D>>::Output

Performs the % operation.

impl Rem<Decimal> for Usd

type Output = Usd

The resulting type after applying the % operator.

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

Performs the % operation.

impl Rem<Usd> for Decimal

type Output = Usd

The resulting type after applying the % operator.

fn rem(self, other: Usd) -> Self::Output

Performs the % operation.

impl SanitizeAuto for Decimal

fn sanitize_self(&mut self, _ctx: &mut dyn VisitorContext)

impl SanitizeCustom for Decimal

fn sanitize_custom(&mut self, _ctx: &mut dyn VisitorContext)

impl Sanitizer<Decimal> for RoundDecimalPlaces

fn sanitize(&self, value: &mut Decimal) -> Result<(), String>

impl Serialize for Decimal

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.

impl Sub<Decimal> for Usd

type Output = Usd

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<Usd> for Decimal

type Output = Usd

The resulting type after applying the - operator.

fn sub(self, other: Usd) -> Self::Output

Performs the - operation.

impl Sub for Decimal

type Output = Decimal

The resulting type after applying the - operator.

fn sub(self, __rhs: Decimal) -> <Decimal as Sub>::Output

Performs the - operation.

impl SubAssign<Decimal> for Usd

fn sub_assign(&mut self, other: Decimal)

Performs the -= operation.

impl SubAssign for Decimal

fn sub_assign(&mut self, __rhs: Decimal)

Performs the -= operation.

impl Sum<Decimal> for Usd

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

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

impl Sum for Decimal

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.

impl ToPrimitive for Decimal

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

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

impl ValidateAuto for Decimal

fn validate_self(&self, _ctx: &mut dyn VisitorContext)

impl ValidateCustom for Decimal

fn validate_custom(&self, _ctx: &mut dyn VisitorContext)

impl Validator<Decimal> for MaxDecimalPlaces

fn validate(&self, n: &Decimal, ctx: &mut dyn VisitorContext)

impl Visitable for Decimal

fn drive(&self, _: &mut dyn VisitorCore)

fn drive_mut(&mut self, _: &mut dyn VisitorMutCore)

impl Atomic for Decimal

impl Copy for Decimal

impl Eq for Decimal

impl StructuralPartialEq for Decimal