Struct MutableDictionaryArray

pub struct MutableDictionaryArray<K: DictionaryKey, M: MutableArray> { /* private fields */ }

Implementations

impl<K: DictionaryKey, M: MutableArray + Default> MutableDictionaryArray<K, M>

pub fn new() -> Self

Creates an empty MutableDictionaryArray.

impl<K: DictionaryKey, M: MutableArray> MutableDictionaryArray<K, M>

pub fn try_empty(values: M) -> PolarsResult<Self>

Creates an empty MutableDictionaryArray from a given empty values array.

Errors

Errors if the array is non-empty.

pub fn from_values(values: M) -> PolarsResult<Self>

where M: Indexable, M::Type: Eq + Hash,

Creates an empty MutableDictionaryArray preloaded with a given dictionary of values. Indices associated with those values are automatically assigned based on the order of the values.

Errors

Errors if there’s more values than the maximum value of K or if values are not unique.

pub fn into_empty(self) -> Self

Creates an empty MutableDictionaryArray retaining the same dictionary as the current mutable dictionary array, but with no data. This may come useful when serializing the array into multiple chunks, where there’s a requirement that the dictionary is the same. No copying is performed, the value map is moved over to the new array.

pub fn to_empty(&self) -> Self

where M: Clone,

Same as into_empty but clones the inner value map instead of taking full ownership.

pub fn push_null(&mut self)

pushes a null value

pub fn values(&self) -> &M

returns a reference to the inner values.

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

converts itself into Arc<dyn 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 MutableDictionaryArray to fit its current length.

pub fn keys(&self) -> &MutablePrimitiveArray<K>

Returns the dictionary keys

Trait Implementations

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

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

Formats the value using the given formatter.

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

fn default() -> Self

Returns the “default value” for a type.

impl<K: DictionaryKey, M: MutableArray> From<MutableDictionaryArray<K, M>> for DictionaryArray<K>

fn from(other: MutableDictionaryArray<K, M>) -> Self

Converts to this type from the input type.

impl<K: DictionaryKey, M: 'static + MutableArray> MutableArray for MutableDictionaryArray<K, 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<K, M, T> TryExtend<Option<T>> for MutableDictionaryArray<K, M>

where K: DictionaryKey, M: MutableArray + Indexable + TryExtend<Option<T>> + TryPush<Option<T>>, T: AsIndexed<M>, M::Type: Eq + Hash,

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

Fallible version of Extend::extend.

impl<K, M, T> TryPush<Option<T>> for MutableDictionaryArray<K, M>

where K: DictionaryKey, M: MutableArray + Indexable + TryPush<Option<T>>, T: AsIndexed<M>, M::Type: Eq + Hash,

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

Tries to push a new element.