Struct MutableListArray

pub struct MutableListArray<O: Offset, M: MutableArray> { /* private fields */ }

The mutable version of ListArray.

Implementations

impl<O: Offset, M: MutableArray + Default> MutableListArray<O, M>

pub fn new() -> Self

Creates a new empty MutableListArray.

pub fn with_capacity(capacity: usize) -> Self

Creates a new MutableListArray with a capacity.

impl<O: Offset, M: MutableArray> MutableListArray<O, M>

pub fn new_from(values: M, dtype: ArrowDataType, capacity: usize) -> Self

Creates a new MutableListArray from a MutableArray and capacity.

pub fn new_with_field(values: M, name: PlSmallStr, nullable: bool) -> Self

Creates a new MutableListArray from a MutableArray.

pub fn new_with_capacity(values: M, capacity: usize) -> Self

Creates a new MutableListArray from a MutableArray and capacity.

pub fn new_from_mutable( values: M, offsets: Offsets<O>, validity: Option<MutableBitmap>, ) -> Self

Creates a new MutableListArray from a MutableArray, Offsets and MutableBitmap.

pub fn try_push_valid(&mut self) -> PolarsResult<()>

Needs to be called when a valid value was extended to this array. This is a relatively low level function, prefer try_push when you can.

pub fn try_extend_from_lengths<II>(&mut self, iterator: II) -> PolarsResult<()>

where II: TrustedLen<Item = Option<usize>> + Clone,

Expand this array, using elements from the underlying backing array. Assumes the expansion begins at the highest previous offset, or zero if this MutableListArray is currently empty.

Panics if:

• the new offsets are not in monotonic increasing order.
• any new offset is not in bounds of the backing array.
• the passed iterator has no upper bound.

pub fn len(&self) -> usize

Returns the length of this array

pub fn mut_values(&mut self) -> &mut M

The values

pub fn offsets(&self) -> &Offsets<O>

The offsets

pub fn values(&self) -> &M

The values

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

Converts itself into an Array.

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

converts itself into Box<dyn Array>

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

Reserves additional slots.

pub fn shrink_to_fit(&mut self)

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

Trait Implementations

impl<O: Clone + Offset, M: Clone + MutableArray> Clone for MutableListArray<O, M>

fn clone(&self) -> MutableListArray<O, M>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<O: Debug + Offset, M: Debug + MutableArray> Debug for MutableListArray<O, M>

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

Formats the value using the given formatter.

impl<O: Offset, M: MutableArray + Default> Default for MutableListArray<O, M>

fn default() -> Self

Returns the “default value” for a type.

impl<O: Offset, M: MutableArray> From<MutableListArray<O, M>> for ListArray<O>

fn from(other: MutableListArray<O, M>) -> Self

Converts to this type from the input type.

impl<O: Offset, M: MutableArray + 'static> MutableArray for MutableListArray<O, M>

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 dtype(&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 reserve(&mut self, additional: usize)

Reserves additional slots to its capacity.

fn shrink_to_fit(&mut self)

Shrink the array to fit its length.

fn is_empty(&self) -> bool

Whether the array is empty.

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

Whether index is valid / set.

impl<O, M, I, T> TryExtend<Option<I>> for MutableListArray<O, M>

where O: Offset, M: MutableArray + TryExtend<Option<T>>, I: IntoIterator<Item = Option<T>>,

fn try_extend<II: IntoIterator<Item = Option<I>>>( &mut self, iter: II, ) -> PolarsResult<()>

Fallible version of Extend::extend.

impl<O, M> TryExtendFromSelf for MutableListArray<O, M>

where O: Offset, M: MutableArray + TryExtendFromSelf,

fn try_extend_from_self(&mut self, other: &Self) -> PolarsResult<()>

Tries to extend itself with elements from other, failing only on overflow.

impl<O, M, I, T> TryPush<Option<I>> for MutableListArray<O, M>

where O: Offset, M: MutableArray + TryExtend<Option<T>>, I: IntoIterator<Item = Option<T>>,

fn try_push(&mut self, item: Option<I>) -> PolarsResult<()>

Tries to push a new element.