Struct arrow::array::ArrayData

source ·

pub struct ArrayData { /* private fields */ }

Expand description

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§

source §

impl ArrayData

source

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

Create a new ArrayData instance;

If null_count is not specified, the number of nulls in null_bit_buffer is calculated.

If the number of nulls is 0 then the null_bit_buffer is set to None.

Safety

The input values must form a valid Arrow array for data_type, or undefined behavior can result.

Note: This is a low level API and most users of the arrow crate should create arrays using the methods in the array module.

source

pub fn try_new(
 data_type: DataType,
 len: usize,
 null_bit_buffer: Option<Buffer>,
 offset: usize,
 buffers: Vec<Buffer, Global>,
 child_data: Vec<ArrayData, Global>
) -> Result<ArrayData, ArrowError>

Create a new ArrayData, validating that the provided buffers form a valid Arrow array of the specified data type.

If the number of nulls in null_bit_buffer is 0 then the null_bit_buffer is set to None.

Internally this calls through to Self::validate_data

Note: This is a low level API and most users of the arrow crate should create arrays using the builders found in arrow_array

source

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

Returns a builder to construct a ArrayData instance.

source

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

Returns a reference to the data type of this array data

source

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

Returns a slice of buffers for this array data

source

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

Returns a slice of children data arrays

source

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

Returns whether the element at index i is null

source

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

Returns a reference to the null bitmap of this array data

source

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

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

source

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

Returns whether the element at index i is not null

source

pub const fn len(&self) -> usize

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

source

pub const fn is_empty(&self) -> bool

source

pub const fn offset(&self) -> usize

Returns the offset of this array

source

pub const fn null_count(&self) -> usize

Returns the total number of nulls in this array

source

pub fn get_buffer_memory_size(&self) -> usize

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

source

pub fn get_array_memory_size(&self) -> usize

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

source

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().

source

pub fn buffer<T>(&self, buffer: usize) -> &[T] ⓘwhere
T: ArrowNativeType,

Returns the buffer as a slice of type T starting at self.offset

Panics

This function panics if:

the buffer is not byte-aligned with type T, or
the datatype is Boolean (it corresponds to a bit-packed buffer where the offset is not applicable)

source

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

Returns a new empty ArrayData valid for data_type.

source

pub fn validate(&self) -> Result<(), ArrowError>

“cheap” validation of an ArrayData. Ensures buffers are sufficiently sized to store len + offset total elements of data_type and performs other inexpensive consistency checks.

This check is “cheap” in the sense that it does not validate the contents of the buffers (e.g. that all offsets for UTF8 arrays are within the bounds of the values buffer).

See ArrayData::validate_data to validate fully the offset content and the validity of utf8 data

source

pub fn validate_data(&self) -> Result<(), ArrowError>

Validate that the data contained within this ArrayData is valid

Null count is correct
All offsets are valid
All String data is valid UTF-8
All dictionary offsets are valid

Internally this calls:

Note: this does not recurse into children, for a recursive variant see Self::validate_full

source

pub fn validate_full(&self) -> Result<(), ArrowError>

Performs a full recursive validation of this ArrayData and all its children

This is equivalent to calling Self::validate_data on this ArrayData and all its children recursively

source

pub fn validate_nulls(&self) -> Result<(), ArrowError>

Validates the values stored within this ArrayData are valid without recursing into child ArrayData

Does not (yet) check

Union type_ids are valid see #85 Validates the the null count is correct and that any nullability requirements of its children are correct

source

pub fn validate_values(&self) -> Result<(), ArrowError>

Validates the values stored within this ArrayData are valid without recursing into child ArrayData

Does not (yet) check

Union type_ids are valid see #85

source

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

Returns true if this ArrayData is equal to other, using pointer comparisons to determine buffer equality. This is cheaper than PartialEq::eq but may return false when the arrays are logically equal

source