Struct BinaryViewArrayGeneric

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

Implementations

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

pub unsafe fn new_unchecked( dtype: ArrowDataType, views: Buffer<View>, buffers: Arc<[Buffer<u8>]>, validity: Option<Bitmap>, total_bytes_len: usize, total_buffer_len: usize, ) -> Self

Safety

The caller must ensure

• the data is valid utf8 (if required)
• The offsets match the buffers.

pub unsafe fn new_unchecked_unknown_md( dtype: ArrowDataType, views: Buffer<View>, buffers: Arc<[Buffer<u8>]>, validity: Option<Bitmap>, total_buffer_len: Option<usize>, ) -> Self

Create a new BinaryViewArray but initialize a statistics compute.

Safety

The caller must ensure the invariants

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

pub fn variadic_buffer_lengths(&self) -> Vec<i64>

pub fn views(&self) -> &Buffer<View>

pub fn into_views(self) -> Vec<View>

pub fn into_inner( self, ) -> (Buffer<View>, Arc<[Buffer<u8>]>, Option<Bitmap>, usize, usize)

pub unsafe fn apply_views<F: FnMut(View, &T) -> View>( &self, update_view: F, ) -> Self

Apply a function over the views. This can be used to update views in operations like slicing.

Safety

Update the views. All invariants of the views apply.

pub fn try_new( dtype: ArrowDataType, views: Buffer<View>, buffers: Arc<[Buffer<u8>]>, validity: Option<Bitmap>, ) -> PolarsResult<Self>

pub fn new_empty(dtype: ArrowDataType) -> Self

Creates an empty BinaryViewArrayGeneric, i.e. whose .len is zero.

pub fn new_null(dtype: ArrowDataType, length: usize) -> Self

Returns a new null BinaryViewArrayGeneric of length.

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

Returns the element at index i

Panics

iff i >= self.len()

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

Returns the element at index i

Safety

Assumes that the i < self.len.

pub fn iter( &self, ) -> ZipValidity<&T, ArrayValuesIter<'_, BinaryViewArrayGeneric<T>>, BitmapIter<'_>>

Returns an iterator of Option<&T> over every element of this array.

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

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

pub fn len_iter(&self) -> impl Iterator<Item = u32> + '_

pub fn non_null_values_iter( &self, ) -> NonNullValuesIter<'_, BinaryViewArrayGeneric<T>>

Returns an iterator of the non-null values.

pub fn non_null_views_iter(&self) -> NonNullValuesIter<'_, Buffer<View>>

Returns an iterator of the non-null values.

pub fn sliced(self, offset: usize, length: usize) -> Self

Returns this array sliced.

Implementation

This function is O(1).

Panics

iff offset + length > self.len().

pub unsafe fn sliced_unchecked(self, offset: usize, length: usize) -> Self

Returns this array sliced.

Implementation

This function is O(1).

Safety

The caller must ensure that offset + length <= self.len().

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

Returns this array with a new validity.

Panic

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

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

Sets the validity of this array.

Panics

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

pub fn take_validity(&mut self) -> Option<Bitmap>

Takes the validity of this array, leaving it without a validity mask.

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

Boxes this array into a Box<dyn Array>.

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

Arcs this array into a std::sync::Arc<dyn Array>.

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

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

pub fn total_bytes_len(&self) -> usize

Get the total length of bytes that it would take to concatenate all binary/str values in this array.

pub fn total_buffer_len(&self) -> usize

Get the length of bytes that are stored in the variadic buffers.

pub fn len(&self) -> usize

pub fn gc(self) -> Self

Garbage collect

pub fn is_sliced(&self) -> bool

pub fn maybe_gc(self) -> Self

pub fn make_mut(self) -> MutableBinaryViewArray<T>

impl BinaryViewArrayGeneric<[u8]>

pub fn validate_utf8(&self) -> PolarsResult<()>

Validate the underlying bytes on UTF-8.

pub fn to_utf8view(&self) -> PolarsResult<Utf8ViewArray>

Convert BinaryViewArray to Utf8ViewArray.

pub unsafe fn to_utf8view_unchecked(&self) -> Utf8ViewArray

Convert BinaryViewArray to Utf8ViewArray without checking UTF-8.

Safety

The caller must ensure the underlying data is valid UTF-8.

impl BinaryViewArrayGeneric<str>

pub fn to_binview(&self) -> BinaryViewArray

Trait Implementations

impl<T: ViewType + ?Sized> Array for BinaryViewArrayGeneric<T>

fn as_any(&self) -> &dyn Any

Converts itself to a reference of Any, which enables downcasting to concrete types.

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

Converts itself to a mutable reference of Any, which enables mutable downcasting to concrete types.

fn len(&self) -> usize

The length of the Array. Every array has a length corresponding to the number of elements (slots).

fn dtype(&self) -> &ArrowDataType

The ArrowDataType of the Array. In combination with Array::as_any, this can be used to downcast trait objects (dyn Array) to concrete arrays.

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

The validity of the Array: every array has an optional Bitmap that, when available specifies whether the array slot is valid or not (null). When the validity is None, all slots are valid.

fn split_at_boxed(&self, offset: usize) -> (Box<dyn Array>, Box<dyn Array>)

Split Self at offset into two boxed Arrays where offset <= self.len().

unsafe fn split_at_boxed_unchecked( &self, offset: usize, ) -> (Box<dyn Array>, Box<dyn Array>)

Split Self at offset into two boxed Arrays without checking offset <= self.len().

fn slice(&mut self, offset: usize, length: usize)

Slices this Array.

unsafe fn slice_unchecked(&mut self, offset: usize, length: usize)

Slices the Array.

fn with_validity(&self, validity: Option<Bitmap>) -> Box<dyn Array>

Clones this Array with a new assigned bitmap.

fn to_boxed(&self) -> Box<dyn Array>

Clone a &dyn Array to an owned Box<dyn Array>.

fn is_empty(&self) -> bool

whether the array is empty

fn null_count(&self) -> usize

The number of null slots on this Array.

fn has_nulls(&self) -> bool

fn is_null(&self, i: usize) -> bool

Returns whether slot i is null.

unsafe fn is_null_unchecked(&self, i: usize) -> bool

Returns whether slot i is null.

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

Returns whether slot i is valid.

fn sliced(&self, offset: usize, length: usize) -> Box<dyn Array>

Returns a slice of this Array.

unsafe fn sliced_unchecked( &self, offset: usize, length: usize, ) -> Box<dyn Array>

Returns a slice of this Array.

impl<'a, T: ViewType + ?Sized> ArrayAccessor<'a> for BinaryViewArrayGeneric<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 BinaryViewArrayGeneric<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, T: ViewType + ?Sized> From<GrowableBinaryViewArray<'a, T>> for BinaryViewArrayGeneric<T>

fn from(val: GrowableBinaryViewArray<'a, T>) -> Self

Converts to this type from the input type.

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<'a, T: ViewType + ?Sized> IntoIterator for &'a BinaryViewArrayGeneric<T>

type Item = Option<&'a T>

The type of the elements being iterated over.

type IntoIter = ZipValidity<&'a T, ArrayValuesIter<'a, BinaryViewArrayGeneric<T>>, BitmapIter<'a>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T: ViewType + ?Sized> PartialEq for BinaryViewArrayGeneric<T>

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl<T: ViewType + ?Sized> Splitable for BinaryViewArrayGeneric<T>

fn check_bound(&self, offset: usize) -> bool

unsafe fn _split_at_unchecked(&self, offset: usize) -> (Self, Self)

Internal implementation of split_at_unchecked. For any usage, prefer the using split_at or split_at_unchecked.

fn split_at(&self, offset: usize) -> (Self, Self)

Split Self at offset where offset <= self.len().

unsafe fn split_at_unchecked(&self, offset: usize) -> (Self, Self)

Split Self at offset without checking offset <= self.len().

impl<T: ViewType + ?Sized> Send for BinaryViewArrayGeneric<T>

impl<T: ViewType + ?Sized> Sync for BinaryViewArrayGeneric<T>