Struct polars_arrow::array::MutableStructArray

pub struct MutableStructArray { /* private fields */ }

Converting a MutableStructArray into a StructArray is O(1).

Implementations

impl MutableStructArray

pub fn new(data_type: ArrowDataType, values: Vec<Box<dyn MutableArray>>) -> Self

Creates a new MutableStructArray.

pub fn try_new( data_type: ArrowDataType, values: Vec<Box<dyn MutableArray>>, validity: Option<MutableBitmap>, ) -> PolarsResult<Self>

Create a MutableStructArray out of low-end APIs.

Errors

This function errors iff:

• data_type is not ArrowDataType::Struct
• The inner types of data_type are not equal to those of values
• validity is not None and its length is different from the values’s length

pub fn into_inner( self, ) -> (ArrowDataType, Vec<Box<dyn MutableArray>>, Option<MutableBitmap>)

Extract the low-end APIs from the MutableStructArray.

pub fn mut_values(&mut self) -> &mut Vec<Box<dyn MutableArray>>

The mutable values

pub fn values(&self) -> &Vec<Box<dyn MutableArray>>

The values

pub fn value<A: MutableArray + 'static>(&mut self, i: usize) -> Option<&mut A>

Return the ith child array.

impl MutableStructArray

pub fn reserve(&mut self, additional: usize)

Reserves additional entries.

pub fn push(&mut self, valid: bool)

Call this once for each “row” of children you push.

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

Converts itself into an Array.

pub fn shrink_to_fit(&mut self)

Shrinks the capacity of the MutableStructArray to fit its current length.

Trait Implementations

impl Debug for MutableStructArray

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

Formats the value using the given formatter.

impl From<MutableStructArray> for StructArray

fn from(other: MutableStructArray) -> Self

Converts to this type from the input type.

impl MutableArray for MutableStructArray

fn len(&self) -> usize

The length of the array.

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

The optional validity of the array.

fn as_box(&mut self) -> Box<dyn Array>

Convert itself to an (immutable) Array.

fn as_arc(&mut self) -> Arc<dyn Array>

Convert itself to an (immutable) atomically reference counted Array.

fn data_type(&self) -> &ArrowDataType

The ArrowDataType of the array.

fn as_any(&self) -> &dyn Any

Convert to Any, to enable dynamic casting.

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

Convert to mutable Any, to enable dynamic casting.

fn push_null(&mut self)

Adds a new null element to the array.

fn shrink_to_fit(&mut self)

Shrink the array to fit its length.

fn reserve(&mut self, additional: usize)

Reserves additional slots to its capacity.

fn is_empty(&self) -> bool

Whether the array is empty.

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

Whether index is valid / set.