Struct polars_arrow::array::MutableFixedSizeBinaryArray

pub struct MutableFixedSizeBinaryArray { /* private fields */ }

The Arrow’s equivalent to a mutable Vec<Option<[u8; size]>>. Converting a MutableFixedSizeBinaryArray into a FixedSizeBinaryArray is O(1).

Implementation

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

Implementations

impl<'a> MutableFixedSizeBinaryArray

pub fn iter( &'a self ) -> ZipValidity<&'a [u8], ChunksExact<'a, u8>, BitmapIter<'a>>

constructs a new iterator

pub fn iter_values(&'a self) -> ChunksExact<'a, u8>

Returns iterator over the values of MutableFixedSizeBinaryArray

impl MutableFixedSizeBinaryArray

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

Creates a new MutableFixedSizeBinaryArray.

Errors

This function returns an error iff:

• The data_type’s physical type is not crate::datatypes::PhysicalType::FixedSizeBinary
• The length of values is not a multiple of size in data_type
• the validity’s length is not equal to values.len() / size.

pub fn new(size: usize) -> Self

Creates a new empty MutableFixedSizeBinaryArray.

pub fn with_capacity(size: usize, capacity: usize) -> Self

Creates a new MutableFixedSizeBinaryArray with capacity for capacity entries.

pub fn from<const N: usize, P: AsRef<[Option<[u8; N]>]>>(slice: P) -> Self

Creates a new MutableFixedSizeBinaryArray from a slice of optional [u8].

pub fn try_push<P: AsRef<[u8]>>(&mut self, value: Option<P>) -> PolarsResult<()>

tries to push a new entry to MutableFixedSizeBinaryArray.

Error

Errors iff the size of value is not equal to its own size.

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

pushes a new entry to MutableFixedSizeBinaryArray.

Panics

Panics iff the size of value is not equal to its own size.

pub fn len(&self) -> usize

Returns the length of this array

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

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

pub fn try_from_iter<P: AsRef<[u8]>, I: IntoIterator<Item = Option<P>>>( iter: I, size: usize ) -> PolarsResult<Self>

Creates a new MutableFixedSizeBinaryArray from an iterator of values.

Errors

Errors iff the size of any of the value is not equal to its own size.

pub fn size(&self) -> usize

returns the (fixed) size of the MutableFixedSizeBinaryArray.

pub fn capacity(&self) -> usize

Returns the capacity of this array

pub fn value(&self, i: usize) -> &[u8]

Returns the element at index i as &[u8]

pub unsafe fn value_unchecked(&self, i: usize) -> &[u8]

Returns the element at index i as &[u8]

Safety

Assumes that the i < self.len.

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

Reserves additional slots.

pub fn shrink_to_fit(&mut self)

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

impl MutableFixedSizeBinaryArray

Accessors

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

Returns its values.

pub fn values_mut_slice(&mut self) -> &mut [u8]

Returns a mutable slice of values.

Trait Implementations

impl Clone for MutableFixedSizeBinaryArray

fn clone(&self) -> MutableFixedSizeBinaryArray

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MutableFixedSizeBinaryArray

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

Formats the value using the given formatter.

impl From<MutableFixedSizeBinaryArray> for FixedSizeBinaryArray

fn from(other: MutableFixedSizeBinaryArray) -> Self

Converts to this type from the input type.

impl<'a> IntoIterator for &'a MutableFixedSizeBinaryArray

type Item = Option<&'a [u8]>

The type of the elements being iterated over.

type IntoIter = ZipValidity<&'a [u8], ChunksExact<'a, u8>, BitmapIter<'a>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl MutableArray for MutableFixedSizeBinaryArray

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 PartialEq for MutableFixedSizeBinaryArray

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 TryExtendFromSelf for MutableFixedSizeBinaryArray

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

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