Struct tarantool::decimal::Decimal

pub struct Decimal { /* private fields */ }

A Decimal number implemented using the builtin tarantool api.

Availability

This api is not available in all versions of tarantool. Use tarantool::ffi::has_decimal to check if it is supported in your case. If has_decimal returns false, using any function from this module will result in a panic.

This API is thread-safe unlike the original tarantool decimal API.

Implementations

impl Decimal

pub unsafe fn from_raw(inner: decNumber) -> Self

Initialize a Decimal instance from a raw decNumber struct

Safety

inner must a be valid instance of decNumber struct

pub fn zero() -> Self

Return a zero decimal number.

pub fn precision(&self) -> i32

Return decimal precision, i.e. the amount of decimal digits in its representation.

pub fn scale(&self) -> i32

Return decimal scale, i.e. the number of decimal digits after the decimal separator.

pub fn is_int(&self) -> bool

Check if the fractional part of the number is 0

pub fn trim(self) -> Self

Remove trailing zeros from the fractional part of a number.

impl Decimal

pub fn round(self) -> Self

Round a given decimal to have zero digits after the decimal point.

pub fn floor(self) -> Self

Floor a given decimal towards zero to have zero digits after the decimal point.

pub fn round_to(self, scale: u8) -> Option<Self>

Round a given decimal to have no more than scale digits after the decimal point. If scale if greater than current self.scale(), return self unchanged. Scale must be in range [0..= ffi::DECIMAL_MAX_DIGITS]. Return None if scale if out of bounds.

pub fn floor_to(self, scale: u8) -> Option<Self>

Like Decimal::round but rounds the number towards zero.

pub fn rescale(self, scale: u8) -> Option<Self>

Set scale of self to scale. If scale < self.scale(), performs the equivalent of self.round(scale). Otherwise appends a sufficient amount of trailing fractional zeros. Return None if scale < 0 or too big.

pub fn abs(self) -> Self

Return the absolute value of the number.

pub fn log10(self) -> Option<Self>

Compute logarithm base 10.

pub fn ln(self) -> Option<Self>

Compute natural logarithm.

pub fn exp(self) -> Option<Self>

Exponentiate self. Return None if the result is out of range.

pub fn sqrt(self) -> Option<Self>

Compute square root of self. Return None if the result is imaginary or out of range.

pub fn pow(self, pow: impl Into<Self>) -> Option<Self>

Compute self raised to the power of pow. Return None if the result is out of range.

pub fn to_i64(self) -> Option<i64>

Convert self to i64. Return None if self is not an integer or the value is out of range.

pub fn to_u64(self) -> Option<u64>

Convert self to u64. Return None if self is not an integer or the value is out of range.

impl Decimal

pub fn checked_add(self, rhs: impl Into<Self>) -> Option<Self>

impl Decimal

pub fn checked_sub(self, rhs: impl Into<Self>) -> Option<Self>

impl Decimal

pub fn checked_mul(self, rhs: impl Into<Self>) -> Option<Self>

impl Decimal

pub fn checked_div(self, rhs: impl Into<Self>) -> Option<Self>

impl Decimal

pub fn checked_rem(self, rhs: impl Into<Self>) -> Option<Self>

Trait Implementations

impl<T: Into<Decimal>> Add<T> for Decimal

type Output = Decimal

The resulting type after applying the + operator.

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

Performs the + operation.

impl<T: Into<Decimal>> AddAssign<T> for Decimal

fn add_assign(&mut self, rhs: T)

Performs the += operation.

impl Clone for Decimal

fn clone(&self) -> Decimal

Returns a copy 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

Formats the value using the given formatter.

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

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Decimal

String conversions

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

Formats the value using the given formatter.

impl<T: Into<Decimal>> Div<T> for Decimal

type Output = Decimal

The resulting type after applying the / operator.

fn div(self, rhs: T) -> Self

Performs the / operation.

impl<T: Into<Decimal>> DivAssign<T> for Decimal

fn div_assign(&mut self, rhs: T)

Performs the /= operation.

impl From<i16> for Decimal

fn from(num: i16) -> Self

Converts to this type from the input type.

impl From<i32> for Decimal

fn from(num: i32) -> Self

Converts to this type from the input type.

impl From<i64> for Decimal

fn from(num: i64) -> Self

Converts to this type from the input type.

impl From<i8> for Decimal

fn from(num: i8) -> Self

Converts to this type from the input type.

impl From<isize> for Decimal

fn from(num: isize) -> Self

Converts to this type from the input type.

impl From<u16> for Decimal

fn from(num: u16) -> Self

Converts to this type from the input type.

impl From<u32> for Decimal

fn from(num: u32) -> Self

Converts to this type from the input type.

impl From<u64> for Decimal

fn from(num: u64) -> Self

Converts to this type from the input type.

impl From<u8> for Decimal

fn from(num: u8) -> Self

Converts to this type from the input type.

impl From<usize> for Decimal

fn from(num: usize) -> Self

Converts to this type from the input type.

impl FromStr for Decimal

type Err = DecimalFromStrError

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

Hash

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<L> LuaRead<L> for Decimal

where L: AsLua,

fn lua_read_at_position(lua: L, index: NonZeroI32) -> ReadResult<Self, L>

Reads the data from Lua at a given position.

fn n_values_expected() -> i32

fn lua_read(lua: L) -> Result<Self, (L, WrongType)>

Reads the data from Lua.

fn lua_read_at_maybe_zero_position( lua: L, index: i32 ) -> Result<Self, (L, WrongType)>

where L: AsLua,

impl<T: Into<Decimal>> Mul<T> for Decimal

type Output = Decimal

The resulting type after applying the * operator.

fn mul(self, rhs: T) -> Self

Performs the * operation.

impl<T: Into<Decimal>> MulAssign<T> for Decimal

fn mul_assign(&mut self, rhs: T)

Performs the *= operation.

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: &Self) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq<i16> for Decimal

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

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

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

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

impl PartialEq<i32> for Decimal

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

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

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

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

impl PartialEq<i64> for Decimal

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

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

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

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

impl PartialEq<i8> for Decimal

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

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

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

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

impl PartialEq<isize> for Decimal

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

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

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

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

impl PartialEq<u16> for Decimal

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

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

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

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

impl PartialEq<u32> for Decimal

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

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

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

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

impl PartialEq<u64> for Decimal

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

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

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

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

impl PartialEq<u8> for Decimal

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

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

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

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

impl PartialEq<usize> for Decimal

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

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

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

This method 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: &Self) -> bool

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

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

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

impl PartialOrd for Decimal

Cmp

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

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<L: AsLua> Push<L> for Decimal

type Err = Void

Error that can happen when pushing a value.

fn push_to_lua(&self, lua: L) -> Result<PushGuard<L>, (Self::Err, L)>

Pushes the value on the top of the stack.

fn push_no_err(&self, lua: L) -> PushGuard<L>

where Self::Err: Into<Void>,

Same as push_to_lua but can only succeed and is only available if Err implements Into<Void>.

impl<L: AsLua> PushInto<L> for Decimal

type Err = Void

fn push_into_lua(self, lua: L) -> Result<PushGuard<L>, (Self::Err, L)>

Push the value into lua by value

fn push_into_no_err(self, lua: L) -> PushGuard<L>

where Self: Sized, Self::Err: Into<Void>,

Same as push_into_lua but can only succeed and is only available if Err implements Into<Void>.

impl<T: Into<Decimal>> Rem<T> for Decimal

type Output = Decimal

The resulting type after applying the % operator.

fn rem(self, rhs: T) -> Self

Performs the % operation.

impl<T: Into<Decimal>> RemAssign<T> for Decimal

fn rem_assign(&mut self, rhs: T)

Performs the %= operation.

impl Serialize for Decimal

Tuple

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: Into<Decimal>> Sub<T> for Decimal

type Output = Decimal

The resulting type after applying the - operator.

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

Performs the - operation.

impl<T: Into<Decimal>> SubAssign<T> for Decimal

fn sub_assign(&mut self, rhs: T)

Performs the -= operation.

impl TryFrom<&CStr> for Decimal

type Error = DecimalFromStrError

The type returned in the event of a conversion error.

fn try_from(s: &CStr) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&str> for Decimal

type Error = <Decimal as FromStr>::Err

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Decimal<{ ffi::DECNUMUNITS as _ }>> for Decimal

type Error = ToDecimalError

The type returned in the event of a conversion error.

fn try_from(inner: Decimal<{ _ }>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Decimal> for i64

type Error = DecimalToIntError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Decimal> for isize

type Error = DecimalToIntError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Decimal> for u64

type Error = DecimalToIntError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Decimal> for usize

type Error = DecimalToIntError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<f32> for Decimal

type Error = DecimalFromfloatError<f32>

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<f64> for Decimal

type Error = DecimalFromfloatError<f64>

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Copy for Decimal

impl Eq for Decimal

impl<L: AsLua> PushOne<L> for Decimal

impl<L: AsLua> PushOneInto<L> for Decimal