Struct arrow_array::decimal::Decimal

pub struct Decimal<T: DecimalType> { /* private fields */ }

Decimal is the generic representation of a single decimal value

See Decimal128 and Decimal256 for the value types of Decimal128Array and Decimal256Array respectively

Implementations

impl<T: DecimalType> Decimal<T>

pub const MAX_PRECISION: u8 = T::MAX_PRECISION

pub const MAX_SCALE: u8 = T::MAX_SCALE

pub const TYPE_CONSTRUCTOR: fn(_: u8, _: u8) -> DataType = T::TYPE_CONSTRUCTOR

pub const DEFAULT_TYPE: DataType = T::DEFAULT_TYPE

pub fn try_new_from_bytes(
    precision: u8,
    scale: u8,
    bytes: &T::Native
) -> Result<Self, ArrowError>where
    Self: Sized,

Tries to create a decimal value from precision, scale and bytes. The bytes should be stored in little-endian order.

Safety: This method doesn’t validate if the decimal value represented by the bytes can be fitted into the specified precision.

pub fn new(precision: u8, scale: u8, bytes: &T::Native) -> Self

Creates a decimal value from precision, scale, and bytes.

Safety: This method doesn’t check if the precision and scale are valid. Use try_new_from_bytes for safe constructor.

pub fn raw_value(&self) -> &T::Native

Returns the raw bytes of the integer representation of the decimal.

pub fn precision(&self) -> u8

Returns the precision of the decimal.

pub fn scale(&self) -> u8

Returns the scale of the decimal.

pub fn to_string(&self) -> String

Returns the string representation of the decimal. If the string representation cannot be fitted with the precision of the decimal, the string will be truncated.

impl Decimal<Decimal128Type>

pub fn new_from_i128(precision: u8, scale: u8, value: i128) -> Self

Creates Decimal128 from an i128 value.

pub fn as_i128(&self) -> i128

Returns i128 representation of the decimal.

impl Decimal<Decimal256Type>

pub fn from_big_int(
    num: &BigInt,
    precision: u8,
    scale: u8
) -> Result<Decimal256, ArrowError>

Constructs a Decimal256 value from a BigInt.

pub fn to_big_int(self) -> BigInt

Constructs a BigInt from this Decimal256 value.

Trait Implementations

impl<T: DecimalType> Clone for Decimal<T>

Manually implement to avoid T: Debug bound

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: DecimalType> Debug for Decimal<T>

Manually implement to avoid T: Debug bound

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

Formats the value using the given formatter.

impl From<Decimal<Decimal128Type>> for i128

fn from(decimal: Decimal128) -> Self

Converts to this type from the input type.

impl<T: DecimalType> Ord for Decimal<T>

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl<T: DecimalType> PartialEq<Decimal<T>> for Decimal<T>

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<T: DecimalType> PartialOrd<Decimal<T>> for Decimal<T>

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<T: DecimalType> Copy for Decimal<T>

impl<T: DecimalType> Eq for Decimal<T>