Struct polars::export::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: DataType,
    types: Buffer<i8>,
    fields: Vec<Arc<dyn Array + 'static>, Global>,
    offsets: Option<Buffer<i32>>
) -> Result<UnionArray, ArrowError>

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
• any of the values’s data type is different from its corresponding children’ data type

pub fn new(
    data_type: DataType,
    types: Buffer<i8>,
    fields: Vec<Arc<dyn Array + 'static>, Global>,
    offsets: Option<Buffer<i32>>
) -> UnionArray

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 from_data(
    data_type: DataType,
    types: Buffer<i8>,
    fields: Vec<Arc<dyn Array + 'static>, Global>,
    offsets: Option<Buffer<i32>>
) -> UnionArray

Alias for new

pub fn new_null(data_type: DataType, length: usize) -> UnionArray

Creates a new null UnionArray.

pub fn new_empty(data_type: DataType) -> UnionArray

Creates a new empty UnionArray.

impl UnionArray

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

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(&self, offset: usize, length: usize) -> UnionArray

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

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<Arc<dyn Array + 'static>, Global>

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 fn value(&self, index: usize) -> Box<dyn Scalar + 'static, Global>

Returns the slot index as a Scalar.

impl UnionArray

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

Returns all fields from DataType::Union.

Panic

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

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

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

Panic

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

Trait Implementations

impl Array for UnionArray

fn as_any(&self) -> &(dyn Any + 'static)

Convert to trait object.

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) -> &DataType

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

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 slice(
    &self,
    offset: usize,
    length: usize
) -> Box<dyn Array + 'static, Global>

Slices the Array, returning a new Box<dyn Array>.

unsafe fn slice_unchecked(
    &self,
    offset: usize,
    length: usize
) -> Box<dyn Array + 'static, Global>

Slices the Array, returning a new Box<dyn Array>.

fn with_validity(&self, Option<Bitmap>) -> Box<dyn Array + 'static, Global>

Sets the validity bitmap on this Array.

fn to_boxed(&self) -> Box<dyn Array + 'static, Global>

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

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.

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

Returns whether slot i is valid.

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<(), Error>

Formats the value using the given formatter.

impl<'a> From<GrowableUnion<'a>> for UnionArray

fn from(val: GrowableUnion<'a>) -> UnionArray

Converts to this type from the input type.

impl<'a> IntoIterator for &'a UnionArray

type Item = Box<dyn Scalar + 'static, Global>

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) -> <&'a UnionArray as IntoIterator>::IntoIter

Creates an iterator from a value.

impl<'_> PartialEq<&'_ (dyn Array + '_)> 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 !=.

impl PartialEq<UnionArray> for UnionArray

fn eq(&self, other: &UnionArray) -> 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 !=.