Struct Decimal 

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

A fixed-point decimal number type.

Implementations

impl Decimal

pub const ZERO: Self

pub const ONE: Self

pub const MIN: Self

pub const MAX: Self

pub const fn is_zero(self) -> bool

Whether this decimal value is zero.

pub const fn is_negative(self) -> bool

Whether this decimal value is negative.

pub fn is_integer(self) -> bool

Whether this decimal has fractional part equal to zero (is an integer).

pub fn abs(self) -> Self

Computes the absolute value of this decimal.

pub fn floor(self) -> Self

Computes the largest integer less than or equal to this decimal.

A decimal is returned as this may not be within i64’s range of values.

pub fn ceil(self) -> Self

Computes the smallest integer greater than or equal to this decimal.

A decimal is returned as this may not be within i64’s range of values.

pub fn trunc(self) -> Self

Returns the integer part of this decimal.

pub fn fract(self) -> Self

Returns the fractional part of this decimal (with the integer part set to zero).

pub fn round(self, digits: i32) -> Option<Self>

Rounds this decimal up to the specified amount of digits with the traditional rounding rules, using the “midpoint away from zero” strategy (6.5 -> 7, -6.5 -> -7).

If given a negative amount of digits, rounds to integer digits instead with the same rounding strategy. For example, rounding to -3 digits will turn 34567.89 into 35000.00 and -34567.89 into -35000.00.

Note that this can return None when using negative digits where the rounded number would overflow the available range for decimals.

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

Attempts to add two decimals.

Returns None on overflow or underflow.

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

Attempts to subtract a decimal from another.

Returns None on overflow or underflow.

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

Attempts to multiply two decimals.

Returns None on overflow or underflow.

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

Attempts to divide two decimals.

Returns None if other is zero, as well as on overflow or underflow.

pub fn checked_div_euclid(self, other: Self) -> Option<Self>

Attempts to obtain the quotient of Euclidean division between two decimals. Implemented similarly to f64::div_euclid.

The returned quotient is truncated and adjusted if the remainder was negative.

Returns None if other is zero, as well as on overflow or underflow.

pub fn checked_rem_euclid(self, other: Self) -> Option<Self>

Attempts to obtain the remainder of Euclidean division between two decimals. Implemented similarly to f64::rem_euclid.

The returned decimal r is non-negative within the range 0.0 <= r < other.abs().

Returns None if other is zero, as well as on overflow or underflow.

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

Attempts to calculate the remainder of the division of two decimals.

Returns None if other is zero, as well as on overflow or underflow.

pub fn checked_powi(self, other: i64) -> Option<Self>

Attempts to take one decimal to the power of an integer.

Returns None for invalid operands, as well as on overflow or underflow.

impl Decimal

pub fn construct( engine: &mut Engine<'_>, value: Spanned<ToDecimal>, ) -> SourceResult<Decimal>

Converts a value to a decimal.

Trait Implementations

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

impl Debug for Decimal

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

Formats the value using the given formatter.

impl Default for Decimal

fn default() -> Decimal

Returns the “default value” for a type.

impl Display for Decimal

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

Formats the value using the given formatter.

impl Eq for Decimal

impl From<i64> for Decimal

fn from(value: i64) -> Self

Converts to this type from the input type.

impl FromStr for Decimal

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

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

impl FromValue for Decimal

fn from_value(value: Value) -> HintedStrResult<Self>

Try to cast the value into an instance of Self.

impl Hash for Decimal

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

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

fn into_value(self) -> Value

Cast this type into a value.

impl NativeScope for Decimal

fn constructor() -> Option<&'static NativeFuncData>

The constructor function for the type, if any.

fn scope() -> Scope

Get the associated scope for the type.

impl NativeType for Decimal

const NAME: &'static str = "decimal"

The type’s name.

fn data() -> &'static NativeTypeData

fn ty() -> Type

Get the type for the native Rust type.

impl Neg for Decimal

type Output = Decimal

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

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

fn input() -> CastInfo

Describe what can be cast into this value.

fn output() -> CastInfo

Describe what this value can be cast into.

fn castable(value: &Value) -> bool

Whether the given value can be converted to T.

fn error(found: &Value) -> HintedString

Produce an error message for an unacceptable value type.

impl Repr for Decimal

fn repr(&self) -> EcoString

Return the debug representation of the value.

impl StructuralPartialEq for Decimal

impl TryFrom<Decimal> for f64

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

Attempts to convert a Decimal to a float.

This should in principle be infallible according to the implementation, but we mirror the decimal implementation’s API either way.

type Error = Error

The type returned in the event of a conversion error.

impl TryFrom<Decimal> for i64

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

Attempts to convert a Decimal to an integer.

Returns an error if the decimal has a fractional part, or if there would be overflow or underflow.

type Error = Error

The type returned in the event of a conversion error.

impl TryFrom<f64> for Decimal

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

Attempts to convert a Decimal to a float.

This can fail if the float is infinite or NaN, or otherwise cannot be represented by a decimal number.

type Error = ()

The type returned in the event of a conversion error.