Struct polars::export::arrow::array::StructArray

pub struct StructArray { /* private fields */ }

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

Example

use std::sync::Arc;
use arrow2::array::*;
use arrow2::datatypes::*;
let boolean = Arc::new(BooleanArray::from_slice(&[false, false, true, true])) as Arc<dyn Array>;
let int = Arc::new(Int32Array::from_slice(&[42, 28, 19, 31])) as Arc<dyn Array>;

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

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

Implementations

impl<'a> StructArray

pub fn iter(
    &'a self
) -> ZipValidity<'a, Vec<Box<dyn Scalar + 'static, Global>, Global>, StructValueIter<'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(
    data_type: DataType,
    values: Vec<Arc<dyn Array + 'static>, Global>,
    validity: Option<Bitmap>
) -> Result<StructArray, ArrowError>

Returns a new StructArray.

Errors

This function errors iff:

• data_type’s physical type is not crate::datatypes::PhysicalType::Struct.
• the children of data_type 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(
    data_type: DataType,
    values: Vec<Arc<dyn Array + 'static>, Global>,
    validity: Option<Bitmap>
) -> StructArray

Returns a new StructArray

Panics

This function panics iff:

• data_type’s physical type is not crate::datatypes::PhysicalType::Struct.
• the children of data_type 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 from_data(
    data_type: DataType,
    values: Vec<Arc<dyn Array + 'static>, Global>,
    validity: Option<Bitmap>
) -> StructArray

Alias for new

pub fn new_empty(data_type: DataType) -> StructArray

Creates an empty StructArray.

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

Creates a null StructArray of length length.

impl StructArray

pub fn into_data(
    self
) -> (Vec<Field, Global>, Vec<Arc<dyn Array + 'static>, Global>, Option<Bitmap>)

Deconstructs the StructArray into its individual components.

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

Creates a new StructArray that is a slice of self.

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

Creates a new StructArray that is a slice of self.

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 with_validity(&self, validity: Option<Bitmap>) -> StructArray

Sets the validity bitmap on this StructArray.

Panic

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

impl StructArray

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

The optional validity.

pub fn values(&self) -> &[Arc<dyn Array + 'static>]

Returns the values of this StructArray.

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

Returns the fields of this StructArray.

impl StructArray

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

Returns the fields the DataType::Struct.

Trait Implementations

impl Array for StructArray

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,
    validity: Option<Bitmap>
) -> Box<dyn Array + 'static, Global>

Sets the validity bitmap on this 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 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

Performs the conversion.

impl<'a> IntoIterator for &'a StructArray

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

The type of the elements being iterated over.

type IntoIter = ZipValidity<'a, Vec<Box<dyn Scalar + 'static, Global>, Global>, StructValueIter<'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 + '_)> for StructArray

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<StructArray> for StructArray

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