Struct arrow::array::ArrayData

pub struct ArrayData { /* fields omitted */ }

An generic representation of Arrow array data which encapsulates common attributes and operations for Arrow array. Specific operations for different arrays types (e.g., primitive, list, struct) are implemented in Array.

Implementations

impl ArrayData

pub fn new(
    data_type: DataType,
    len: usize,
    null_count: Option<usize>,
    null_bit_buffer: Option<Buffer>,
    offset: usize,
    buffers: Vec<Buffer>,
    child_data: Vec<ArrayData>
) -> Self

pub const fn builder(data_type: DataType) -> ArrayDataBuilder

Returns a builder to construct a ArrayData instance.

pub const fn data_type(&self) -> &DataType

Returns a reference to the data type of this array data

pub fn buffers(&self) -> &[Buffer]

Returns a slice of buffers for this array data

pub fn child_data(&self) -> &[ArrayData]

Returns a slice of children data arrays

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

Returns whether the element at index i is null

pub const fn null_bitmap(&self) -> &Option<Bitmap>

Returns a reference to the null bitmap of this array data

pub fn null_buffer(&self) -> Option<&Buffer>

Returns a reference to the null buffer of this array data.

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

Returns whether the element at index i is not null

pub const fn len(&self) -> usize

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

pub const fn is_empty(&self) -> bool

pub const fn offset(&self) -> usize

Returns the offset of this array

pub const fn null_count(&self) -> usize

Returns the total number of nulls in this array

pub fn get_buffer_memory_size(&self) -> usize

Returns the total number of bytes of memory occupied by the buffers owned by this ArrayData.

pub fn get_array_memory_size(&self) -> usize

Returns the total number of bytes of memory occupied physically by this ArrayData.

pub fn slice(&self, offset: usize, length: usize) -> ArrayData

Creates a zero-copy slice of itself. This creates a new ArrayData with a different offset, len and a shifted null bitmap.

Panics

Panics if offset + length > self.len().

pub fn new_empty(data_type: &DataType) -> Self

Returns a new empty ArrayData valid for data_type.

Trait Implementations

impl Clone for ArrayData

fn clone(&self) -> ArrayData

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ArrayData

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

Formats the value using the given formatter.

impl<OffsetSize: BinaryOffsetSizeTrait> From<ArrayData> for GenericBinaryArray<OffsetSize>

fn from(data: ArrayData) -> Self

Performs the conversion.

impl From<ArrayData> for FixedSizeBinaryArray

fn from(data: ArrayData) -> Self

Performs the conversion.

impl From<ArrayData> for UnionArray

fn from(data: ArrayData) -> Self

Performs the conversion.

impl From<ArrayData> for NullArray

fn from(data: ArrayData) -> Self

Performs the conversion.

impl From<ArrayData> for DecimalArray

fn from(data: ArrayData) -> Self

Performs the conversion.

impl From<ArrayData> for BooleanArray

fn from(data: ArrayData) -> Self

Performs the conversion.

impl<T: ArrowPrimitiveType> From<ArrayData> for DictionaryArray<T>

Constructs a DictionaryArray from an array data reference.

fn from(data: ArrayData) -> Self

Performs the conversion.

impl<OffsetSize: OffsetSizeTrait> From<ArrayData> for GenericListArray<OffsetSize>

fn from(data: ArrayData) -> Self

Performs the conversion.

impl From<ArrayData> for FixedSizeListArray

fn from(data: ArrayData) -> Self

Performs the conversion.

impl<T: ArrowPrimitiveType> From<ArrayData> for PrimitiveArray<T>

Constructs a PrimitiveArray from an array data reference.

fn from(data: ArrayData) -> Self

Performs the conversion.

impl<OffsetSize: StringOffsetSizeTrait> From<ArrayData> for GenericStringArray<OffsetSize>

fn from(data: ArrayData) -> Self

Performs the conversion.

impl From<ArrayData> for StructArray

fn from(data: ArrayData) -> Self

Performs the conversion.

impl PartialEq<ArrayData> for ArrayData

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 TryFrom<ArrayData> for ArrowArray

type Error = ArrowError

The type returned in the event of a conversion error.

fn try_from(value: ArrayData) -> Result<Self>

Performs the conversion.

impl TryFrom<ArrowArray> for ArrayData

type Error = ArrowError

The type returned in the event of a conversion error.

fn try_from(value: ArrowArray) -> Result<Self>

Performs the conversion.