Struct arrow::util::decimal::Decimal128

pub struct Decimal128 { /* private fields */ }

Represents a decimal value with precision and scale. The decimal value could represented by a signed 128-bit integer.

Implementations

impl Decimal128

pub fn as_i128(&self) -> i128

Returns i128 representation of the decimal.

Trait Implementations

impl BasicDecimal for Decimal128

const BIT_WIDTH: usize = 128usize

The bit-width of the internal representation.

fn new(precision: usize, scale: usize, bytes: &[u8]) -> Self

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

fn raw_value(&self) -> &[u8]

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

fn precision(&self) -> usize

Returns the precision of the decimal.

fn scale(&self) -> usize

Returns the scale of the decimal.

fn try_new_from_bytes(
    precision: usize,
    scale: usize,
    bytes: &[u8]
) -> Result<Self> where
    Self: Sized, 

Tries to create a decimal value from precision, scale and bytes. If the length of bytes isn’t same as the bit width of this decimal, returning an error. The bytes should be stored in little-endian order.

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 BasicDecimalArray<Decimal128, Decimal128Array> for Decimal128Array

const VALUE_LENGTH: i32 = 16i32

fn data(&self) -> &ArrayData

fn precision(&self) -> usize

Return the precision (total digits) that can be stored by this array

fn scale(&self) -> usize

Return the scale (digits after the decimal) that can be stored by this array

fn value(&self, i: usize) -> T

Returns the element at index i.

fn value_offset(&self, i: usize) -> i32

Returns the offset for the element at index i.

fn value_length(&self) -> i32

Returns the length for an element.

fn value_data(&self) -> Buffer

Returns a clone of the value data buffer

fn value_offset_at(&self, i: usize) -> i32

fn value_as_string(&self, row: usize) -> String

fn from_fixed_size_binary_array(
    v: FixedSizeBinaryArray,
    precision: usize,
    scale: usize
) -> U

Build a decimal array from FixedSizeBinaryArray.

fn from_fixed_size_list_array(
    v: FixedSizeListArray,
    precision: usize,
    scale: usize
) -> U

👎 Deprecated:

please use from_fixed_size_binary_array instead

Build a decimal array from FixedSizeListArray.

impl Debug for Decimal128

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

Formats the value using the given formatter.

impl From<Decimal128> for i128

fn from(decimal: Decimal128) -> Self

Converts to this type from the input type.

impl Ord for Decimal128

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) -> Self

Restrict a value to a certain interval.

impl PartialEq<Decimal128> for Decimal128

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 !=.

impl PartialOrd<Decimal128> for Decimal128

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 Eq for Decimal128