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

pub fn builder(data_type: DataType) -> ArrayDataBuilder

Returns a builder to construct a ArrayData instance.

pub 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) -> &[ArrayDataRef]

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 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 fn len(&self) -> usize

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

pub fn is_empty(&self) -> bool

pub fn offset(&self) -> usize

Returns the offset of this array

pub fn null_count(&self) -> usize

Returns the total number of nulls in this array

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 PartialEq<ArrayData> for ArrayData

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

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

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

This method tests for !=.

impl StructuralPartialEq for ArrayData