Trait MutableArray

pub trait MutableArray:
    Debug
    + Send
    + Sync {
    // Required methods
    fn dtype(&self) -> &ArrowDataType;
    fn len(&self) -> usize;
    fn validity(&self) -> Option<&MutableBitmap>;
    fn as_box(&mut self) -> Box<dyn Array>;
    fn as_any(&self) -> &dyn Any;
    fn as_mut_any(&mut self) -> &mut dyn Any;
    fn push_null(&mut self);
    fn reserve(&mut self, additional: usize);
    fn shrink_to_fit(&mut self);

    // Provided methods
    fn is_empty(&self) -> bool { ... }
    fn as_arc(&mut self) -> Arc<dyn Array> { ... }
    fn is_valid(&self, index: usize) -> bool { ... }
}

A trait describing a mutable array; i.e. an array whose values can be changed.

Mutable arrays cannot be cloned but can be mutated in place, thereby making them useful to perform numeric operations without allocations. As in Array, concrete arrays (such as MutablePrimitiveArray) implement how they are mutated.

Required Methods

fn dtype(&self) -> &ArrowDataType

The ArrowDataType of the array.

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

Provided Methods

fn is_empty(&self) -> bool

Whether the array is empty.

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

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

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

Whether index is valid / set.

Panic

Panics if index >= self.len().

Trait Implementations

impl MutableArray for Box<dyn MutableArray>

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

Implementations on Foreign Types

impl MutableArray for Box<dyn MutableArray>

fn len(&self) -> usize

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

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

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

fn dtype(&self) -> &ArrowDataType

fn as_any(&self) -> &dyn Any

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

fn push_null(&mut self)

fn shrink_to_fit(&mut self)

fn reserve(&mut self, additional: usize)

Implementors

impl MutableArray for polars_arrow::legacy::array::null::MutableNullArray

impl MutableArray for MutableBooleanArray

impl MutableArray for MutableFixedSizeBinaryArray

impl MutableArray for polars_arrow::array::MutableNullArray

impl<K: DictionaryKey, M: 'static + MutableArray> MutableArray for MutableDictionaryArray<K, M>

impl<M: MutableArray + 'static> MutableArray for MutableFixedSizeListArray<M>

impl<O: Offset> MutableArray for MutableBinaryArray<O>

impl<O: Offset> MutableArray for MutableBinaryValuesArray<O>

impl<O: Offset> MutableArray for MutableUtf8Array<O>

impl<O: Offset> MutableArray for MutableUtf8ValuesArray<O>

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

impl<T: NativeType> MutableArray for MutablePrimitiveArray<T>

impl<T: ViewType + ?Sized> MutableArray for MutableBinaryViewArray<T>