Struct arrow::array::UnionArray

pub struct UnionArray { /* fields omitted */ }

An Array that can represent slots of varying types

Implementations

impl UnionArray

pub fn new(
    type_ids: Buffer,
    value_offsets: Option<Buffer>,
    child_arrays: Vec<(Field, ArrayRef)>,
    bitmap_data: Option<(Buffer, usize)>
) -> Self

Creates a new UnionArray.

Accepts type ids, child arrays and optionally offsets (for dense unions) to create a new UnionArray. This method makes no attempt to validate the data provided by the caller and assumes that each of the components are correct and consistent with each other. See try_new for an alternative that validates the data provided.

Data Consistency

The type_ids Buffer should contain i8 values. These values should be greater than zero and must be less than the number of children provided in child_arrays. These values are used to index into the child_arrays.

The value_offsets Buffer is only provided in the case of a dense union, sparse unions should use None. If provided the value_offsets Buffer should contain i32 values. These values should be greater than zero and must be less than the length of the overall array.

In both cases above we use signed integer types to maintain compatibility with other Arrow implementations.

In both of the cases above we are accepting Buffer's which are assumed to be representing i8 and i32 values respectively. Buffer objects are untyped and no attempt is made to ensure that the data provided is valid.

pub fn try_new(
    type_ids: Buffer,
    value_offsets: Option<Buffer>,
    child_arrays: Vec<(Field, ArrayRef)>,
    bitmap: Option<Buffer>
) -> Result<Self>

Attempts to create a new UnionArray and validates the inputs provided.

pub fn child(&self, type_id: i8) -> ArrayRef

Accesses the child array for type_id.

Panics

Panics if the type_id provided is less than zero or greater than the number of types in the Union.

pub fn type_id(&self, index: usize) -> i8

Returns the type_id for the array slot at index.

Panics

Panics if index is greater than the length of the array.

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

Returns the offset into the underlying values array for the array slot at index.

Panics

Panics if index is greater than the length of the array.

pub fn value(&self, index: usize) -> ArrayRef

Returns the array's value at index.

Panics

Panics if index is greater than the length of the array.

pub fn type_names(&self) -> Vec<&str>

Returns the names of the types in the union.

Trait Implementations

impl Array for UnionArray

fn as_any(&self) -> &dyn Any

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

fn data(&self) -> ArrayDataRef

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

fn data_ref(&self) -> &ArrayDataRef

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

fn get_buffer_memory_size(&self) -> usize

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

fn get_array_memory_size(&self) -> usize

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

fn data_type(&self) -> &DataType

Returns a reference to the DataType of this array.

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

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.

impl ArrayEqual for UnionArray

fn equals(&self, _other: &dyn Array) -> bool

Returns true if this array is equal to the other array

fn range_equals(
    &self,
    _other: &dyn Array,
    _start_idx: usize,
    _end_idx: usize,
    _other_start_idx: usize
) -> bool

Returns true if the range [start_idx, end_idx) is equal to [other_start_idx, other_start_idx + end_idx - start_idx) in the other array

impl Debug for UnionArray

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

Formats the value using the given formatter.

impl From<Arc<ArrayData>> for UnionArray

fn from(data: ArrayDataRef) -> Self

Performs the conversion.

impl JsonEqual for UnionArray

fn equals_json(&self, _json: &[&Value]) -> bool

Checks whether arrow array equals to json array.

fn equals_json_values(&self, json: &[Value]) -> bool

Checks whether arrow array equals to json array.