polars_arrow::array

Struct MutableDictionaryArray

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

Implementations§

Source§

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

Source

pub fn new() -> Self

Creates an empty MutableDictionaryArray.

Source§

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

Source

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.

Source

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.

Source

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.

Source

pub fn to_empty(&self) -> Self
where M: Clone,

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

Source

pub fn push_null(&mut self)

pushes a null value

Source

pub fn values(&self) -> &M

returns a reference to the inner values.

Source

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

converts itself into Arc<dyn Array>

Source

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

converts itself into Box<dyn Array>

Source

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

Reserves additional slots.

Source

pub fn shrink_to_fit(&mut self)

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

Source

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

Returns the dictionary keys

Trait Implementations§

Source§

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

Source§

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

Formats the value using the given formatter. Read more
Source§

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

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

fn len(&self) -> usize

The length of the array.
Source§

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

The optional validity of the array.
Source§

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

Convert itself to an (immutable) Array.
Source§

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

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

fn dtype(&self) -> &ArrowDataType

The ArrowDataType of the array.
Source§

fn as_any(&self) -> &dyn Any

Convert to Any, to enable dynamic casting.
Source§

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

Convert to mutable Any, to enable dynamic casting.
Source§

fn push_null(&mut self)

Adds a new null element to the array.
Source§

fn reserve(&mut self, additional: usize)

Reserves additional slots to its capacity.
Source§

fn shrink_to_fit(&mut self)

Shrink the array to fit its length.
Source§

fn is_empty(&self) -> bool

Whether the array is empty.
Source§

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

Whether index is valid / set. Read more
Source§

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,

Source§

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

Fallible version of Extend::extend.
Source§

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,

Source§

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

Tries to push a new element.

Auto Trait Implementations§

§

impl<K, M> Freeze for MutableDictionaryArray<K, M>
where M: Freeze,

§

impl<K, M> RefUnwindSafe for MutableDictionaryArray<K, M>
where M: RefUnwindSafe,

§

impl<K, M> Send for MutableDictionaryArray<K, M>

§

impl<K, M> Sync for MutableDictionaryArray<K, M>

§

impl<K, M> Unpin for MutableDictionaryArray<K, M>
where M: Unpin, K: Unpin,

§

impl<K, M> UnwindSafe for MutableDictionaryArray<K, M>
where M: UnwindSafe, K: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize = _

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.