Struct MutableFixedSizeListArray

pub struct MutableFixedSizeListArray<M: MutableArray> { /* private fields */ }

The mutable version of FixedSizeListArray.

Implementations

impl<M: MutableArray> MutableFixedSizeListArray<M>

pub fn new(values: M, size: usize) -> Self

Creates a new MutableFixedSizeListArray from a MutableArray and size.

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

Creates a new MutableFixedSizeListArray from a MutableArray and size.

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

Creates a new MutableFixedSizeListArray from a MutableArray, ArrowDataType and size.

pub const fn size(&self) -> usize

Returns the size (number of elements per slot) of this FixedSizeListArray.

pub fn len(&self) -> usize

The length of this array

pub fn values(&self) -> &M

The inner values

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 push_valid(&mut self)

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

Reserves additional slots.

pub fn shrink_to_fit(&mut self)

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

Trait Implementations

impl<M: Clone + MutableArray> Clone for MutableFixedSizeListArray<M>

fn clone(&self) -> MutableFixedSizeListArray<M>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<M: Debug + MutableArray> Debug for MutableFixedSizeListArray<M>

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

Formats the value using the given formatter.

impl<M: MutableArray> From<MutableFixedSizeListArray<M>> for FixedSizeListArray

fn from(other: MutableFixedSizeListArray<M>) -> Self

Converts to this type from the input type.

impl<M: MutableArray + 'static> MutableArray for MutableFixedSizeListArray<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<M, I, T> PushUnchecked<Option<I>> for MutableFixedSizeListArray<M>

where M: MutableArray + Extend<Option<T>>, I: IntoIterator<Item = Option<T>>,

unsafe fn push_unchecked(&mut self, item: Option<I>)

Safety

The caller must ensure that the I iterates exactly over size items, where size is the fixed size width.

impl<M, I, T> TryExtend<Option<I>> for MutableFixedSizeListArray<M>

where 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<M> TryExtendFromSelf for MutableFixedSizeListArray<M>

where 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<M, I, T> TryPush<Option<I>> for MutableFixedSizeListArray<M>

where 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.