Struct polars_arrow::array::MutableBinaryViewArray

pub struct MutableBinaryViewArray<T: ViewType + ?Sized> { /* private fields */ }

Implementations

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

pub fn new() -> Self

pub fn with_capacity(capacity: usize) -> Self

pub fn views_mut(&mut self) -> &mut Vec<View>

pub fn views(&self) -> &[View]

pub fn completed_buffers(&self) -> &[Buffer<u8>]

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

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

Reserves additional elements and additional_buffer on the buffer.

pub fn len(&self) -> usize

pub fn capacity(&self) -> usize

pub unsafe fn push_view(&mut self, v: View, buffers: &[Buffer<u8>])

Safety

• caller must allocate enough capacity
• caller must ensure the view and buffers match.

pub fn push_value_ignore_validity<V: AsRef<T>>(&mut self, value: V)

pub fn push_value<V: AsRef<T>>(&mut self, value: V)

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

pub fn push_null(&mut self)

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

pub fn extend_constant<V: AsRef<T>>( &mut self, additional: usize, value: Option<V>, )

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

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

where I: Iterator<Item = P>, P: AsRef<T>,

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

where I: TrustedLen<Item = P>, P: AsRef<T>,

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

where I: Iterator<Item = Option<P>>, P: AsRef<T>,

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

where I: TrustedLen<Item = Option<P>>, P: AsRef<T>,

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

where I: Iterator<Item = Option<P>>, P: AsRef<T>,

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

where I: Iterator<Item = P>, P: AsRef<T>,

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

pub fn freeze(self) -> BinaryViewArrayGeneric<T>

pub fn value(&self, i: usize) -> &T

pub unsafe fn value_unchecked(&self, i: usize) -> &T

Returns the element at index i

Safety

Assumes that the i < self.len.

pub unsafe fn value_from_view_unchecked<'a>(&'a self, view: &'a View) -> &'a T

Returns the element indicated by the given view.

Safety

Assumes the View belongs to this MutableBinaryViewArray.

pub fn values_iter(&self) -> ArrayValuesIter<'_, MutableBinaryViewArray<T>>

Returns an iterator of &[u8] over every element of this array, ignoring the validity

impl MutableBinaryViewArray<[u8]>

pub fn validate_utf8( &mut self, buffer_offset: usize, views_offset: usize, ) -> PolarsResult<()>

Trait Implementations

impl<'a, T: ViewType + ?Sized> ArrayAccessor<'a> for MutableBinaryViewArray<T>

type Item = &'a T

unsafe fn value_unchecked(&'a self, index: usize) -> Self::Item

Safety

fn len(&self) -> usize

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

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

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

fn default() -> Self

Returns the “default value” for a type.

impl<T: ViewType + ?Sized, P: AsRef<T>> Extend<Option<P>> for MutableBinaryViewArray<T>

fn extend<I: IntoIterator<Item = Option<P>>>(&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<T: ViewType + ?Sized> From<MutableBinaryViewArray<T>> for BinaryViewArrayGeneric<T>

fn from(value: MutableBinaryViewArray<T>) -> Self

Converts to this type from the input type.

impl<T: ViewType + ?Sized, P: AsRef<T>> FromIterator<Option<P>> for MutableBinaryViewArray<T>

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

Creates a value from an iterator.

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

fn data_type(&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.

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.

impl<T, K> Pushable<Option<T>> for MutableBinaryViewArray<K>

where T: AsRef<K>, K: ViewType + ?Sized,

type Freeze = BinaryViewArrayGeneric<K>

fn reserve(&mut self, additional: usize)

fn push(&mut self, value: Option<T>)

fn len(&self) -> usize

fn push_null(&mut self)

fn extend_constant(&mut self, additional: usize, value: Option<T>)

fn extend_null_constant(&mut self, additional: usize)

fn freeze(self) -> Self::Freeze

fn with_capacity(capacity: usize) -> Self

impl<T, K> Pushable<T> for MutableBinaryViewArray<K>

where T: AsRef<K> + NoOption, K: ViewType + ?Sized,

type Freeze = BinaryViewArrayGeneric<K>

fn reserve(&mut self, additional: usize)

fn push(&mut self, value: T)

fn len(&self) -> usize

fn push_null(&mut self)

fn extend_constant(&mut self, additional: usize, value: T)

fn extend_null_constant(&mut self, additional: usize)

fn freeze(self) -> Self::Freeze

fn with_capacity(capacity: usize) -> Self

impl<T: ViewType + ?Sized, P: AsRef<T>> TryExtend<Option<P>> for MutableBinaryViewArray<T>

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

This is infallible and is implemented for consistency with all other types

impl<T: ViewType + ?Sized, P: AsRef<T>> TryPush<Option<P>> for MutableBinaryViewArray<T>

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

This is infallible and is implemented for consistency with all other types