Struct polars_arrow::array::UnionArray

pub struct UnionArray { /* private fields */ }

UnionArray represents an array whose each slot can contain different values.

Implementations

impl<'a> UnionArray

pub fn iter(&'a self) -> UnionIter<'a>

constructs a new iterator

impl UnionArray

pub fn try_new( data_type: ArrowDataType, types: Buffer<i8>, fields: Vec<Box<dyn Array>>, offsets: Option<Buffer<i32>>, ) -> PolarsResult<Self>

Returns a new UnionArray.

Errors

This function errors iff:

• data_type’s physical type is not crate::datatypes::PhysicalType::Union.
• the fields’s len is different from the data_type’s children’s length
• The number of fields is larger than i8::MAX
• any of the values’s data type is different from its corresponding children’ data type

pub fn new( data_type: ArrowDataType, types: Buffer<i8>, fields: Vec<Box<dyn Array>>, offsets: Option<Buffer<i32>>, ) -> Self

Returns a new UnionArray.

Panics

This function panics iff:

• data_type’s physical type is not crate::datatypes::PhysicalType::Union.
• the fields’s len is different from the data_type’s children’s length
• any of the values’s data type is different from its corresponding children’ data type

pub fn new_null(data_type: ArrowDataType, length: usize) -> Self

Creates a new null UnionArray.

pub fn new_empty(data_type: ArrowDataType) -> Self

Creates a new empty UnionArray.

impl UnionArray

pub fn slice(&mut self, offset: usize, length: usize)

Returns a slice of this UnionArray.

Implementation

This operation is O(F) where F is the number of fields.

Panic

This function panics iff offset + length > self.len().

pub unsafe fn slice_unchecked(&mut self, offset: usize, length: usize)

Returns a slice of this UnionArray.

Implementation

This operation is O(F) where F is the number of fields.

Safety

The caller must ensure that offset + length <= self.len().

pub fn sliced(self, offset: usize, length: usize) -> Self

Returns this array sliced.

Implementation

This function is O(1).

Panics

iff offset + length > self.len().

pub unsafe fn sliced_unchecked(self, offset: usize, length: usize) -> Self

Returns this array sliced.

Implementation

This function is O(1).

Safety

The caller must ensure that offset + length <= self.len().

pub fn boxed(self) -> Box<dyn Array>

Boxes this array into a Box<dyn Array>.

pub fn arced(self) -> Arc<dyn Array>

Arcs this array into a std::sync::Arc<dyn Array>.

impl UnionArray

pub fn len(&self) -> usize

Returns the length of this array

pub fn offsets(&self) -> Option<&Buffer<i32>>

The optional offsets.

pub fn fields(&self) -> &Vec<Box<dyn Array>>

The fields.

pub fn types(&self) -> &Buffer<i8>

The types.

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

Returns the index and slot of the field to select from self.fields.

pub unsafe fn index_unchecked(&self, index: usize) -> (usize, usize)

Returns the index and slot of the field to select from self.fields. The first value is guaranteed to be < self.fields().len()

Safety

This function is safe iff index < self.len.

pub fn value(&self, index: usize) -> Box<dyn Scalar>

Returns the slot index as a Scalar.

Panics

iff index >= self.len()

pub unsafe fn value_unchecked(&self, index: usize) -> Box<dyn Scalar>

Returns the slot index as a Scalar.

Safety

This function is safe iff i < self.len.

impl UnionArray

pub fn get_fields(data_type: &ArrowDataType) -> &[Field]

Returns all fields from ArrowDataType::Union.

Panic

Panics iff data_type’s logical type is not ArrowDataType::Union.

pub fn is_sparse(data_type: &ArrowDataType) -> bool

Returns whether the ArrowDataType::Union is sparse or not.

Panic

Panics iff data_type’s logical type is not ArrowDataType::Union.

Trait Implementations

impl Array for UnionArray

fn as_any(&self) -> &dyn Any

Converts itself to a reference of Any, which enables downcasting to concrete types.

fn as_any_mut(&mut self) -> &mut dyn Any

Converts itself to a mutable reference of Any, which enables mutable downcasting to concrete types.

fn len(&self) -> usize

The length of the Array. Every array has a length corresponding to the number of elements (slots).

fn data_type(&self) -> &ArrowDataType

The ArrowDataType of the Array. In combination with Array::as_any, this can be used to downcast trait objects (dyn Array) to concrete arrays.

fn split_at_boxed(&self, offset: usize) -> (Box<dyn Array>, Box<dyn Array>)

Split Self at offset into two boxed Arrays where offset <= self.len().

unsafe fn split_at_boxed_unchecked( &self, offset: usize, ) -> (Box<dyn Array>, Box<dyn Array>)

Split Self at offset into two boxed Arrays without checking offset <= self.len().

fn slice(&mut self, offset: usize, length: usize)

Slices this Array.

unsafe fn slice_unchecked(&mut self, offset: usize, length: usize)

Slices the Array.

fn to_boxed(&self) -> Box<dyn Array>

Clone a &dyn Array to an owned Box<dyn Array>.

fn validity(&self) -> Option<&Bitmap>

The validity of the Array: every array has an optional Bitmap that, when available specifies whether the array slot is valid or not (null). When the validity is None, all slots are valid.

fn with_validity(&self, _: Option<Bitmap>) -> Box<dyn Array>

Clones this Array with a new new assigned bitmap.

fn is_empty(&self) -> bool

whether the array is empty

fn null_count(&self) -> usize

The number of null slots on this Array.

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

Returns whether slot i is null.

unsafe fn is_null_unchecked(&self, i: usize) -> bool

Returns whether slot i is null.

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

Returns whether slot i is valid.

fn sliced(&self, offset: usize, length: usize) -> Box<dyn Array>

Returns a slice of this Array.

unsafe fn sliced_unchecked( &self, offset: usize, length: usize, ) -> Box<dyn Array>

Returns a slice of this Array.

impl Arrow2Arrow for UnionArray

fn to_data(&self) -> ArrayData

Convert this Array into [ArrayData]

fn from_data(data: &ArrayData) -> Self

Create this Array from [ArrayData]

impl Clone for UnionArray

fn clone(&self) -> UnionArray

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UnionArray

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

Formats the value using the given formatter.

impl<'a> IntoIterator for &'a UnionArray

type Item = Box<dyn Scalar>

The type of the elements being iterated over.

type IntoIter = UnionIter<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq<&(dyn Array + 'static)> for UnionArray

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

impl PartialEq for UnionArray

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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Splitable for UnionArray

fn check_bound(&self, offset: usize) -> bool

unsafe fn _split_at_unchecked(&self, offset: usize) -> (Self, Self)

Internal implementation of split_at_unchecked. For any usage, prefer the using split_at or split_at_unchecked.

fn split_at(&self, offset: usize) -> (Self, Self)

Split Self at offset where offset <= self.len().

unsafe fn split_at_unchecked(&self, offset: usize) -> (Self, Self)

Split Self at offset without checking offset <= self.len().