Struct StructArray

pub struct StructArray { /* private fields */ }

Available on crate feature polars-io only.

A StructArray is a nested [Array] with an optional validity representing multiple [Array] with the same number of rows.

Example

use polars_arrow::array::*;
use polars_arrow::datatypes::*;
let boolean = BooleanArray::from_slice(&[false, false, true, true]).boxed();
let int = Int32Array::from_slice(&[42, 28, 19, 31]).boxed();

let fields = vec![
    Field::new("b".into(), ArrowDataType::Boolean, false),
    Field::new("c".into(), ArrowDataType::Int32, false),
];

let array = StructArray::new(ArrowDataType::Struct(fields), 4, vec![boolean, int], None);

Implementations

impl<'a> StructArray

pub fn iter( &'a self, ) -> ZipValidity<Vec<Box<dyn Scalar>>, StructValueIter<'a>, BitmapIter<'a>>

Returns an iterator of Option<Box<dyn Array>>

pub fn values_iter(&'a self) -> StructValueIter<'a>

Returns an iterator of Box<dyn Array>

impl StructArray

pub fn try_new( dtype: ArrowDataType, length: usize, values: Vec<Box<dyn Array>>, validity: Option<Bitmap>, ) -> Result<StructArray, PolarsError>

Returns a new StructArray.

Errors

This function errors iff:

• dtype’s physical type is not [crate::datatypes::PhysicalType::Struct].
• the children of dtype are empty
• the values’s len is different from children’s length
• any of the values’s data type is different from its corresponding children’ data type
• any element of values has a different length than the first element
• the validity’s length is not equal to the length of the first element

pub fn new( dtype: ArrowDataType, length: usize, values: Vec<Box<dyn Array>>, validity: Option<Bitmap>, ) -> StructArray

Returns a new StructArray

Panics

This function panics iff:

• dtype’s physical type is not [crate::datatypes::PhysicalType::Struct].
• the children of dtype are empty
• the values’s len is different from children’s length
• any of the values’s data type is different from its corresponding children’ data type
• any element of values has a different length than the first element
• the validity’s length is not equal to the length of the first element

pub fn new_empty(dtype: ArrowDataType) -> StructArray

Creates an empty StructArray.

pub fn new_null(dtype: ArrowDataType, length: usize) -> StructArray

Creates a null StructArray of length length.

impl StructArray

pub fn into_data( self, ) -> (Vec<Field>, usize, Vec<Box<dyn Array>>, Option<Bitmap>)

Deconstructs the StructArray into its individual components.

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

Slices this StructArray.

Panics

• offset + length must be smaller than self.len().

Implementation

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

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

Slices this StructArray.

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 propagate_nulls(&self) -> StructArray

Set the outer nulls into the inner arrays.

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

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, ) -> StructArray

Returns this array sliced.

Implementation

This function is O(1).

Safety

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

pub fn with_validity(self, validity: Option<Bitmap>) -> StructArray

Returns this array with a new validity.

Panic

Panics iff validity.len() != self.len().

pub fn set_validity(&mut self, validity: Option<Bitmap>)

Sets the validity of this array.

Panics

This function panics iff values.len() != self.len().

pub fn take_validity(&mut self) -> Option<Bitmap>

Takes the validity of this array, leaving it without a validity mask.

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 StructArray

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

The optional validity.

pub fn values(&self) -> &[Box<dyn Array>]

Returns the values of this StructArray.

pub fn fields(&self) -> &[Field]

Returns the fields of this StructArray.

impl StructArray

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

Returns the fields the DataType::Struct.

Trait Implementations

impl Array for StructArray

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

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

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

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 dtype(&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 [Array]s 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 [Array]s 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, validity: Option<Bitmap>) -> Box<dyn Array>

Clones this [Array] with a 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 has_nulls(&self) -> bool

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 ArrayFromIter<()> for StructArray

fn arr_from_iter<I>(_iter: I) -> StructArray

where I: IntoIterator<Item = ()>,

fn try_arr_from_iter<E, I>(_iter: I) -> Result<StructArray, E>

where I: IntoIterator<Item = Result<(), E>>,

fn arr_from_iter_trusted<I>(iter: I) -> Self

where I: IntoIterator<Item = T>, <I as IntoIterator>::IntoIter: TrustedLen,

fn try_arr_from_iter_trusted<E, I>(iter: I) -> Result<Self, E>

where I: IntoIterator<Item = Result<T, E>>, <I as IntoIterator>::IntoIter: TrustedLen,

impl ArrayFromIter<Option<()>> for StructArray

fn arr_from_iter<I>(_iter: I) -> StructArray

where I: IntoIterator<Item = Option<()>>,

fn try_arr_from_iter<E, I>(_iter: I) -> Result<StructArray, E>

where I: IntoIterator<Item = Result<Option<()>, E>>,

fn arr_from_iter_trusted<I>(iter: I) -> Self

where I: IntoIterator<Item = T>, <I as IntoIterator>::IntoIter: TrustedLen,

fn try_arr_from_iter_trusted<E, I>(iter: I) -> Result<Self, E>

where I: IntoIterator<Item = Result<T, E>>, <I as IntoIterator>::IntoIter: TrustedLen,

impl ArrayFromIterDtype<()> for StructArray

fn arr_from_iter_with_dtype<I>(_dtype: ArrowDataType, _iter: I) -> StructArray

where I: IntoIterator<Item = ()>,

fn try_arr_from_iter_with_dtype<E, I>( _dtype: ArrowDataType, _iter: I, ) -> Result<StructArray, E>

where I: IntoIterator<Item = Result<(), E>>,

fn arr_from_iter_trusted_with_dtype<I>(dtype: ArrowDataType, iter: I) -> Self

where I: IntoIterator<Item = T>, <I as IntoIterator>::IntoIter: TrustedLen,

fn try_arr_from_iter_trusted_with_dtype<E, I>( dtype: ArrowDataType, iter: I, ) -> Result<Self, E>

where I: IntoIterator<Item = Result<T, E>>, <I as IntoIterator>::IntoIter: TrustedLen,

impl ArrayFromIterDtype<Option<()>> for StructArray

fn arr_from_iter_with_dtype<I>(_dtype: ArrowDataType, _iter: I) -> StructArray

where I: IntoIterator<Item = Option<()>>,

fn try_arr_from_iter_with_dtype<E, I>( _dtype: ArrowDataType, _iter: I, ) -> Result<StructArray, E>

where I: IntoIterator<Item = Result<Option<()>, E>>,

fn arr_from_iter_trusted_with_dtype<I>(dtype: ArrowDataType, iter: I) -> Self

where I: IntoIterator<Item = T>, <I as IntoIterator>::IntoIter: TrustedLen,

fn try_arr_from_iter_trusted_with_dtype<E, I>( dtype: ArrowDataType, iter: I, ) -> Result<Self, E>

where I: IntoIterator<Item = Result<T, E>>, <I as IntoIterator>::IntoIter: TrustedLen,

impl Clone for StructArray

fn clone(&self) -> StructArray

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StructArray

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

Formats the value using the given formatter.

impl<'a> From<GrowableStruct<'a>> for StructArray

fn from(val: GrowableStruct<'a>) -> StructArray

Converts to this type from the input type.

impl<'a> IntoIterator for &'a StructArray

type Item = Option<Vec<Box<dyn Scalar>>>

The type of the elements being iterated over.

type IntoIter = ZipValidity<Vec<Box<dyn Scalar>>, StructValueIter<'a>, BitmapIter<'a>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <&'a StructArray as IntoIterator>::IntoIter

Creates an iterator from a value.

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

fn eq(&self, other: &&(dyn Array + 'static)) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq for StructArray

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Splitable for StructArray

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

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

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

impl StaticArray for StructArray

type ValueT<'a> = ()

type ZeroableValueT<'a> = ()

type ValueIterT<'a> = Repeat<()>

fn with_validity_typed(self, validity: Option<Bitmap>) -> StructArray

fn full_null(length: usize, dtype: ArrowDataType) -> StructArray

fn get(&self, idx: usize) -> Option<Self::ValueT<'_>>

unsafe fn get_unchecked(&self, idx: usize) -> Option<Self::ValueT<'_>>

Safety

fn last(&self) -> Option<Self::ValueT<'_>>

fn value(&self, idx: usize) -> Self::ValueT<'_>

unsafe fn value_unchecked(&self, idx: usize) -> Self::ValueT<'_>

Safety

fn as_slice(&self) -> Option<&[Self::ValueT<'_>]>

fn iter( &self, ) -> ZipValidity<Self::ValueT<'_>, Self::ValueIterT<'_>, BitmapIter<'_>>

fn values_iter(&self) -> Self::ValueIterT<'_>

fn from_vec(v: Vec<Self::ValueT<'_>>, dtype: ArrowDataType) -> Self

fn from_zeroable_vec( v: Vec<Self::ZeroableValueT<'_>>, dtype: ArrowDataType, ) -> Self

fn full(length: usize, value: Self::ValueT<'_>, dtype: ArrowDataType) -> Self

impl TotalEqKernel for StructArray

type Scalar = Box<dyn Array>

fn tot_eq_kernel(&self, other: &StructArray) -> Bitmap

fn tot_ne_kernel(&self, other: &StructArray) -> Bitmap

fn tot_eq_kernel_broadcast( &self, _other: &<StructArray as TotalEqKernel>::Scalar, ) -> Bitmap

fn tot_ne_kernel_broadcast( &self, _other: &<StructArray as TotalEqKernel>::Scalar, ) -> Bitmap

fn tot_eq_missing_kernel(&self, other: &Self) -> Bitmap

fn tot_ne_missing_kernel(&self, other: &Self) -> Bitmap

fn tot_eq_missing_kernel_broadcast(&self, other: &Self::Scalar) -> Bitmap

fn tot_ne_missing_kernel_broadcast(&self, other: &Self::Scalar) -> Bitmap

impl TryFrom<StructArray> for DataFrame

type Error = PolarsError

The type returned in the event of a conversion error.

fn try_from(arr: StructArray) -> Result<DataFrame, PolarsError>

Performs the conversion.