Struct arrow2::array::MutableBinaryValuesArray

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

A MutableArray that builds a BinaryArray. It differs from MutableBinaryArray in that it builds non-null BinaryArray.

Implementations

impl<O: Offset> MutableBinaryValuesArray<O>

pub fn new() -> Self

Returns an empty MutableBinaryValuesArray.

pub fn try_new(
    data_type: DataType,
    offsets: Offsets<O>,
    values: Vec<u8>
) -> Result<Self>

Returns a MutableBinaryValuesArray created from its internal representation.

Errors

This function returns an error iff:

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

Implementation

This function is O(1)

pub fn default_data_type() -> DataType

Returns the default DataType of this container: DataType::Utf8 or DataType::LargeUtf8 depending on the generic Offset.

pub fn with_capacity(capacity: usize) -> Self

Initializes a new MutableBinaryValuesArray with a pre-allocated capacity of items.

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

Initializes a new MutableBinaryValuesArray with a pre-allocated capacity of items and values.

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

returns its values.

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

returns its offsets.

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

Reserves additional elements and additional_values on the values.

pub fn capacity(&self) -> usize

Returns the capacity in number of items

pub fn len(&self) -> usize

Returns the length of this array

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

Pushes a new item 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 MutableBinaryValuesArray. This function returns None iff this array is empty.

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

Returns the value of the element at index i.

Panic

This function panics iff i >= self.len.

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

Returns the value of the element at index i.

Safety

This function is safe iff i < self.len.

pub fn iter(&self) -> ArrayValuesIter<'_, Self>

Returns an iterator of &[u8]

pub fn shrink_to_fit(&mut self)

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

pub fn into_inner(self) -> (DataType, Offsets<O>, Vec<u8>)

Extract the low-end APIs from the MutableBinaryValuesArray.

impl<O: Offset> MutableBinaryValuesArray<O>

pub fn extend_trusted_len<I, P>(&mut self, iterator: I)where
    P: AsRef<[u8]>,
    I: TrustedLen<Item = P>,

Extends the MutableBinaryValuesArray from a TrustedLen

pub unsafe fn extend_trusted_len_unchecked<I, P>(&mut self, iterator: I)where
    P: AsRef<[u8]>,
    I: Iterator<Item = P>,

Extends MutableBinaryValuesArray from an iterator of trusted len.

Safety

The iterator must be trusted len.

pub fn from_trusted_len_iter<I, P>(iterator: I) -> Selfwhere
    P: AsRef<[u8]>,
    I: TrustedLen<Item = P>,

Creates a MutableBinaryValuesArray from a TrustedLen

pub unsafe fn from_trusted_len_iter_unchecked<I, P>(iterator: I) -> Selfwhere
    P: AsRef<[u8]>,
    I: Iterator<Item = P>,

Returns a new MutableBinaryValuesArray from an iterator of trusted length.

Safety

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

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

Returns a new MutableBinaryValuesArray from an iterator.

Error

This operation errors iff the total length in bytes on the iterator exceeds O’s maximum value. (i32::MAX or i64::MAX respectively).

Trait Implementations

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

fn clone(&self) -> MutableBinaryValuesArray<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 MutableBinaryValuesArray<O>

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

Formats the value using the given formatter.

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

fn default() -> Self

Returns the “default value” for a type.

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

fn extend<I: IntoIterator<Item = 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<MutableBinaryValuesArray<O>> for BinaryArray<O>

fn from(other: MutableBinaryValuesArray<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<P> for MutableBinaryValuesArray<O>

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

Creates a value from an iterator.

impl<'a, O: Offset> IntoIterator for &'a MutableBinaryValuesArray<O>

type Item = &'a [u8]

The type of the elements being iterated over.

type IntoIter = ArrayValuesIter<'a, MutableBinaryValuesArray<O>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<O: Offset> MutableArray for MutableBinaryValuesArray<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) -> &DataType

The DataType 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, T: AsRef<[u8]>> TryExtend<T> for MutableBinaryValuesArray<O>

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

Fallible version of Extend::extend.

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

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

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

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

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

Tries to push a new element.