Struct arrow::array::DecimalArray

pub struct DecimalArray<T>where
    T: DecimalType,{ /* private fields */ }

A generic Array for fixed width decimal numbers

See Decimal128Array and Decimal256Array

Implementations

impl<T> DecimalArray<T>where
    T: DecimalType,

pub const VALUE_LENGTH: i32 = T::BYTE_LENGTH as i32

pub const MAX_PRECISION: u8 = T::MAX_PRECISION

pub const MAX_SCALE: u8 = T::MAX_SCALE

pub fn data(&self) -> &ArrayData

pub fn precision(&self) -> u8

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

pub fn scale(&self) -> u8

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

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

Returns the element at index i.

Panics

Panics if index i is out of bounds.

pub unsafe fn value_unchecked(&self, i: usize) -> Decimal<T>

Returns the element at index i.

Safety

Caller is responsible for ensuring that the index is within the bounds of the array

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

Returns the offset for the element at index i.

Note this doesn’t do any bound checking, for performance reason.

pub fn value_length(&self) -> i32

Returns the length for an element.

All elements have the same length as the array is a fixed size.

pub fn value_data(&self) -> Buffer

Returns a clone of the value data buffer

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

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

pub fn from_fixed_size_binary_array(
    v: FixedSizeBinaryArray,
    precision: u8,
    scale: u8
) -> DecimalArray<T>

Build a decimal array from FixedSizeBinaryArray.

NB: This function does not validate that each value is in the permissible range for a decimal

pub fn from_fixed_size_list_array(
    v: FixedSizeListArray,
    precision: u8,
    scale: u8
) -> DecimalArray<T>

👎Deprecated: please use from_fixed_size_binary_array instead

Build a decimal array from FixedSizeListArray.

NB: This function does not validate that each value is in the permissible range for a decimal.

pub const fn default_type() -> DataType

The default precision and scale used when not specified.

pub fn with_precision_and_scale(
    self,
    precision: u8,
    scale: u8
) -> Result<DecimalArray<T>, ArrowError>where
    DecimalArray<T>: Sized,

Returns a Decimal array with the same data as self, with the specified precision.

Returns an Error if:

1. precision is larger than Self::MAX_PRECISION
2. scale is larger than Self::MAX_SCALE;
3. scale is > precision

impl DecimalArray<Decimal128Type>

pub fn from_iter_values<I>(iter: I) -> DecimalArray<Decimal128Type>where
    I: IntoIterator<Item = i128>,

Creates a Decimal128Array with default precision and scale, based on an iterator of i128 values without nulls

impl<'a, T> DecimalArray<T>where
    T: DecimalType,

pub fn iter(&'a self) -> ArrayIter<&'a DecimalArray<T>>

constructs a new iterator

Trait Implementations

impl<T> Array for DecimalArray<T>where
    T: DecimalType,

fn as_any(&self) -> &(dyn Any + 'static)

Returns the array as Any so that it can be downcasted to a specific implementation.

fn data(&self) -> &ArrayData

Returns a reference to the underlying data of this array.

fn into_data(self) -> ArrayData

Returns the underlying data of this array.

fn data_ref(&self) -> &ArrayData

Returns a reference-counted pointer to the underlying data of this array.

fn data_type(&self) -> &DataType

Returns a reference to the DataType of this array.

fn slice(&self, offset: usize, length: usize) -> Arc<dyn Array + 'static>

Returns a zero-copy slice of this array with the indicated offset and length.

fn len(&self) -> usize

Returns the length (i.e., number of elements) of this array.

fn is_empty(&self) -> bool

Returns whether this array is empty.

fn offset(&self) -> usize

Returns the offset into the underlying data used by this array(-slice). Note that the underlying data can be shared by many arrays. This defaults to 0.

fn is_null(&self, index: usize) -> bool

Returns whether the element at index is null. When using this function on a slice, the index is relative to the slice.

fn is_valid(&self, index: usize) -> bool

Returns whether the element at index is not null. When using this function on a slice, the index is relative to the slice.

fn null_count(&self) -> usize

Returns the total number of null values in this array.

fn get_buffer_memory_size(&self) -> usize

Returns the total number of bytes of memory pointed to by this array. The buffers store bytes in the Arrow memory format, and include the data as well as the validity map.

fn get_array_memory_size(&self) -> usize

Returns the total number of bytes of memory occupied physically by this array. This value will always be greater than returned by get_buffer_memory_size() and includes the overhead of the data structures that contain the pointers to the various buffers.

impl<'a, T> ArrayAccessor for &'a DecimalArray<T>where
    T: DecimalType,

type Item = Decimal<T>

fn value(&self, index: usize) -> <&'a DecimalArray<T> as ArrayAccessor>::Item

Returns the element at index i

unsafe fn value_unchecked(
    &self,
    index: usize
) -> <&'a DecimalArray<T> as ArrayAccessor>::Item

Returns the element at index i

impl<T> Debug for DecimalArray<T>where
    T: DecimalType,

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

Formats the value using the given formatter.

impl<T> From<ArrayData> for DecimalArray<T>where
    T: DecimalType,

fn from(data: ArrayData) -> DecimalArray<T>

Converts to this type from the input type.

impl<T> From<DecimalArray<T>> for ArrayDatawhere
    T: DecimalType,

fn from(array: DecimalArray<T>) -> ArrayData

Converts to this type from the input type.

impl<Ptr> FromIterator<Option<Ptr>> for DecimalArray<Decimal128Type>where
    Ptr: Into<i128>,

fn from_iter<I>(iter: I) -> DecimalArray<Decimal128Type>where
    I: IntoIterator<Item = Option<Ptr>>,

Creates a value from an iterator.

impl<Ptr> FromIterator<Option<Ptr>> for DecimalArray<Decimal256Type>where
    Ptr: Into<Decimal<Decimal256Type>>,

fn from_iter<I>(iter: I) -> DecimalArray<Decimal256Type>where
    I: IntoIterator<Item = Option<Ptr>>,

Creates a value from an iterator.

impl<'a, T> IntoIterator for &'a DecimalArray<T>where
    T: DecimalType,

type Item = Option<Decimal<T>>

The type of the elements being iterated over.

type IntoIter = ArrayIter<&'a DecimalArray<T>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <&'a DecimalArray<T> as IntoIterator>::IntoIter

Creates an iterator from a value.

impl PartialEq<DecimalArray<Decimal128Type>> for DecimalArray<Decimal128Type>

fn eq(&self, other: &DecimalArray<Decimal128Type>) -> 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.