Struct polars_arrow::array::MutableBinaryArray

pub struct MutableBinaryArray<O: Offset> { /* private fields */ }

The Arrow’s equivalent to Vec<Option<Vec<u8>>>. Converting a MutableBinaryArray into a BinaryArray is O(1).

Implementation

This struct does not allocate a validity until one is required (i.e. push a null to it).

Implementations

impl<O: Offset> MutableBinaryArray<O>

pub fn new() -> Self

Creates a new empty MutableBinaryArray.

Implementation

This allocates a Vec of one element

pub fn try_new( data_type: ArrowDataType, offsets: Offsets<O>, values: Vec<u8>, validity: Option<MutableBitmap>, ) -> PolarsResult<Self>

Returns a MutableBinaryArray created from its internal representation.

Errors

This function returns an error iff:

• The last offset is not equal to the values’ length.
• the validity’s length is not equal to offsets.len().
• The data_type’s crate::datatypes::PhysicalType is not equal to either Binary or LargeBinary.

Implementation

This function is O(1)

pub fn from<T: AsRef<[u8]>, P: AsRef<[Option<T>]>>(slice: P) -> Self

Creates a new MutableBinaryArray from a slice of optional &[u8].

pub fn with_capacity(capacity: usize) -> Self

Initializes a new MutableBinaryArray with a pre-allocated capacity of slots.

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

Initializes a new MutableBinaryArray with a pre-allocated capacity of slots and values.

Implementation

This does not allocate the validity.

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

Reserves additional elements and additional_values on the values buffer.

pub fn push<T: AsRef<[u8]>>(&mut self, value: Option<T>)

Pushes a new element to the array.

Panic

This operation panics iff the length of all values (in bytes) exceeds O maximum value.

pub fn pop(&mut self) -> Option<Vec<u8>>

Pop the last entry from MutableBinaryArray. This function returns None iff this array is empty

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

Converts itself into an Array.

pub fn shrink_to_fit(&mut self)

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

pub fn with_validity(self, validity: Option<MutableBitmap>) -> Self

Returns this array with a new validity.

Panic

Panics iff validity.len() != self.len().

pub fn set_validity(&mut self, validity: Option<MutableBitmap>)

Sets the validity of this array.

Panics

This function panics iff values.len() != self.len().

pub fn apply_validity<F: FnOnce(MutableBitmap) -> MutableBitmap>( &mut self, f: F, )

Applies a function f to the validity of this array.

This is an API to leverage clone-on-write

Panics

This function panics if the function f modifies the length of the Bitmap.

impl<O: Offset> MutableBinaryArray<O>

pub fn values(&self) -> &Vec<u8>

returns its values.

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

returns its offsets.

pub fn iter( &self, ) -> ZipValidity<&[u8], ArrayValuesIter<'_, MutableBinaryValuesArray<O>>, BitmapIter<'_>>

Returns an iterator of Option<&[u8]>

pub fn values_iter(&self) -> ArrayValuesIter<'_, MutableBinaryValuesArray<O>>

Returns an iterator over the values of this array

impl<O: Offset> MutableBinaryArray<O>

pub unsafe fn from_trusted_len_iter_unchecked<I, P>(iterator: I) -> Self

where P: AsRef<[u8]>, I: Iterator<Item = Option<P>>,

Creates a MutableBinaryArray from an iterator of trusted length.

Safety

The iterator must be TrustedLen. I.e. that size_hint().1 correctly reports its length.

pub fn from_trusted_len_iter<I, P>(iterator: I) -> Self

where P: AsRef<[u8]>, I: TrustedLen<Item = Option<P>>,

Creates a MutableBinaryArray from an iterator of trusted length.

pub unsafe fn from_trusted_len_values_iter_unchecked<T: AsRef<[u8]>, I: Iterator<Item = T>>( iterator: I, ) -> Self

Creates a new BinaryArray from a TrustedLen of &[u8].

Safety

The iterator must be TrustedLen. I.e. that size_hint().1 correctly reports its length.

pub fn from_trusted_len_values_iter<T: AsRef<[u8]>, I: TrustedLen<Item = T>>( iterator: I, ) -> Self

Creates a new BinaryArray from a TrustedLen of &[u8].

pub unsafe fn try_from_trusted_len_iter_unchecked<E, I, P>( iterator: I, ) -> Result<Self, E>

where P: AsRef<[u8]>, I: IntoIterator<Item = Result<Option<P>, E>>,

Creates a MutableBinaryArray from an falible iterator of trusted length.

Safety

The iterator must be TrustedLen. I.e. that size_hint().1 correctly reports its length.

pub fn try_from_trusted_len_iter<E, I, P>(iterator: I) -> Result<Self, E>

where P: AsRef<[u8]>, I: TrustedLen<Item = Result<Option<P>, E>>,

Creates a MutableBinaryArray from an falible iterator of trusted length.

pub fn extend_trusted_len_values<I, P>(&mut self, iterator: I)

where P: AsRef<[u8]>, I: TrustedLen<Item = P>,

Extends the MutableBinaryArray from an iterator of trusted length. This differs from extend_trusted_len which accepts iterator of optional values.

pub fn extend_values<I, P>(&mut self, iterator: I)

where P: AsRef<[u8]>, I: Iterator<Item = P>,

Extends the MutableBinaryArray from an iterator of values. This differs from extended_trusted_len which accepts iterator of optional values.

pub unsafe fn extend_trusted_len_values_unchecked<I, P>(&mut self, iterator: I)

where P: AsRef<[u8]>, I: Iterator<Item = P>,

Extends the MutableBinaryArray from an iterator of values of trusted length. This differs from extend_trusted_len_unchecked which accepts iterator of optional values.

Safety

The iterator must be TrustedLen

pub fn extend_trusted_len<I, P>(&mut self, iterator: I)

where P: AsRef<[u8]>, I: TrustedLen<Item = Option<P>>,

Extends the MutableBinaryArray from an iterator of TrustedLen

pub unsafe fn extend_trusted_len_unchecked<I, P>(&mut self, iterator: I)

where P: AsRef<[u8]>, I: Iterator<Item = Option<P>>,

Extends the MutableBinaryArray from an iterator of TrustedLen

Safety

The iterator must be TrustedLen

pub fn from_iter_values<T: AsRef<[u8]>, I: Iterator<Item = T>>( iterator: I, ) -> Self

Creates a new MutableBinaryArray from a Iterator of &[u8].

pub fn extend_fallible<T, I, E>(&mut self, iter: I) -> Result<(), E>

where E: Error, I: IntoIterator<Item = Result<Option<T>, E>>, T: AsRef<[u8]>,

Extend with a fallible iterator

Trait Implementations

impl<O: Clone + Offset> Clone for MutableBinaryArray<O>

fn clone(&self) -> MutableBinaryArray<O>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<O: Debug + Offset> Debug for MutableBinaryArray<O>

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

Formats the value using the given formatter.

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

fn default() -> Self

Returns the “default value” for a type.

impl<O: Offset, T: AsRef<[u8]>> Extend<Option<T>> for MutableBinaryArray<O>

fn extend<I: IntoIterator<Item = Option<T>>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<O: Offset> From<MutableBinaryArray<O>> for BinaryArray<O>

fn from(other: MutableBinaryArray<O>) -> Self

Converts to this type from the input type.

impl<O: Offset> From<MutableBinaryValuesArray<O>> for MutableBinaryArray<O>

fn from(other: MutableBinaryValuesArray<O>) -> Self

Converts to this type from the input type.

impl<O: Offset, P: AsRef<[u8]>> FromIterator<Option<P>> for MutableBinaryArray<O>

fn from_iter<I: IntoIterator<Item = Option<P>>>(iter: I) -> Self

Creates a value from an iterator.

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

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 data_type(&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: Offset> PartialEq for MutableBinaryArray<O>

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<O: Offset, T: AsRef<[u8]>> TryExtend<Option<T>> for MutableBinaryArray<O>

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

Fallible version of Extend::extend.

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

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

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

impl<O: Offset, T: AsRef<[u8]>> TryPush<Option<T>> for MutableBinaryArray<O>

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

Tries to push a new element.