Struct polars::export::arrow::array::BinaryArray

pub struct BinaryArray<O> where
    O: Offset,  { /* private fields */ }

A BinaryArray is a nullable array of bytes - the Arrow equivalent of Vec<Option<Vec<u8>>>.

Safety

The following invariants hold:

• Two consecutives offsets casted (as) to usize are valid slices of values.
• len is equal to validity.len(), when defined.

Implementations

impl<'a, O> BinaryArray<O> where
    O: Offset, 

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

Returns an iterator of Option<&[u8]>

pub fn values_iter(&'a self) -> BinaryValueIter<'a, O>

Returns an iterator of &[u8]

impl<O> BinaryArray<O> where
    O: Offset, 

pub fn from_slice<T, P>(slice: P) -> BinaryArray<O> where
    T: AsRef<[u8]>,
    P: AsRef<[T]>, 

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

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

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

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

Creates a BinaryArray from an iterator of trusted length.

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

Creates a new BinaryArray from a Iterator of &str.

impl<O> BinaryArray<O> where
    O: Offset, 

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

Creates a BinaryArray 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) -> BinaryArray<O> where
    P: AsRef<[u8]>,
    I: TrustedLen<Item = Option<P>>, 

Creates a BinaryArray from an iterator of trusted length.

pub unsafe fn try_from_trusted_len_iter_unchecked<E, I, P>(
    iterator: I
) -> Result<BinaryArray<O>, E> where
    P: AsRef<[u8]>,
    I: IntoIterator<Item = Result<Option<P>, E>>, 

Creates a BinaryArray 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>(iter: I) -> Result<BinaryArray<O>, E> where
    P: AsRef<[u8]>,
    I: TrustedLen<Item = Result<Option<P>, E>>, 

Creates a BinaryArray from an fallible iterator of trusted length.

impl<O> BinaryArray<O> where
    O: Offset, 

pub fn try_new(
    data_type: DataType,
    offsets: Buffer<O>,
    values: Buffer<u8>,
    validity: Option<Bitmap>
) -> Result<BinaryArray<O>, ArrowError>

Creates a new BinaryArray.

Errors

This function returns an error iff:

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

Implementation

This function is O(N) - checking monotinicity is O(N)

pub fn new(
    data_type: DataType,
    offsets: Buffer<O>,
    values: Buffer<u8>,
    validity: Option<Bitmap>
) -> BinaryArray<O>

Creates a new BinaryArray.

Panics

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

Implementation

This function is O(N) - checking monotinicity is O(N)

pub fn from_data(
    data_type: DataType,
    offsets: Buffer<O>,
    values: Buffer<u8>,
    validity: Option<Bitmap>
) -> BinaryArray<O>

Alias for new

pub fn new_empty(data_type: DataType) -> BinaryArray<O>

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

pub fn new_null(data_type: DataType, length: usize) -> BinaryArray<O>

Creates an null BinaryArray, i.e. whose .null_count() == .len().

pub fn default_data_type() -> DataType

Returns the default DataType, DataType::Binary or DataType::LargeBinary

impl<O> BinaryArray<O> where
    O: Offset, 

pub unsafe fn try_new_unchecked(
    data_type: DataType,
    offsets: Buffer<O>,
    values: Buffer<u8>,
    validity: Option<Bitmap>
) -> Result<BinaryArray<O>, ArrowError>

Creates a new BinaryArray without checking for offsets monotinicity.

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() - 1.
• The data_type’s crate::datatypes::PhysicalType is not equal to either Binary or LargeBinary.

Safety

This function is unsafe iff:

• the offsets are not monotonically increasing

Implementation

This function is O(1)

pub unsafe fn new_unchecked(
    data_type: DataType,
    offsets: Buffer<O>,
    values: Buffer<u8>,
    validity: Option<Bitmap>
) -> BinaryArray<O>

Creates a new BinaryArray without checking for offsets monotinicity.

Panics

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() - 1.
• The data_type’s crate::datatypes::PhysicalType is not equal to either Binary or LargeBinary.

Safety

This function is unsafe iff:

• the offsets are not monotonically increasing

Implementation

This function is O(1)

pub unsafe fn from_data_unchecked(
    data_type: DataType,
    offsets: Buffer<O>,
    values: Buffer<u8>,
    validity: Option<Bitmap>
) -> BinaryArray<O>

Alias for [new_unchecked]

Safety

This function is unsafe iff:

• the offsets are not monotonically increasing

impl<O> BinaryArray<O> where
    O: Offset, 

pub fn slice(&self, offset: usize, length: usize) -> BinaryArray<O>

Creates a new BinaryArray by slicing this BinaryArray.

Implementation

This function is O(1): all data will be shared between both arrays.

Panics

iff offset + length > self.len().

pub unsafe fn slice_unchecked(
    &self,
    offset: usize,
    length: usize
) -> BinaryArray<O>

Creates a new BinaryArray by slicing this BinaryArray.

Implementation

This function is O(1): all data will be shared between both arrays.

Safety

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

pub fn with_validity(&self, validity: Option<Bitmap>) -> BinaryArray<O>

Clones this BinaryArray with a different validity.

Panic

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

impl<O> BinaryArray<O> where
    O: Offset, 

pub fn len(&self) -> usize

Returns the length of this array

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

Returns the element at index i

Panics

iff i >= self.len()

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

Returns the element at index i

Safety

Assumes that the i < self.len.

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

The optional validity.

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

Returns the offsets that slice .values() to return valid values.

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

Returns all values in this array. Use .offsets() to slice them.

Trait Implementations

impl<O> Array for BinaryArray<O> where
    O: Offset, 

fn as_any(&self) -> &(dyn Any + 'static)

Convert to trait object.

fn len(&self) -> usize

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

fn data_type(&self) -> &DataType

The DataType 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 slice(
    &self,
    offset: usize,
    length: usize
) -> Box<dyn Array + 'static, Global>

Slices the Array, returning a new Box<dyn Array>.

unsafe fn slice_unchecked(
    &self,
    offset: usize,
    length: usize
) -> Box<dyn Array + 'static, Global>

Slices the Array, returning a new Box<dyn Array>.

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

Sets the validity bitmap on this Array.

fn to_boxed(&self) -> Box<dyn Array + 'static, Global>

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 is_null(&self, i: usize) -> bool

Returns whether slot i is null.

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

Returns whether slot i is valid.

impl<O> Clone for BinaryArray<O> where
    O: Clone + Offset, 

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<O> Debug for BinaryArray<O> where
    O: Offset, 

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

Formats the value using the given formatter.

impl<'a, O> From<GrowableBinary<'a, O>> for BinaryArray<O> where
    O: Offset, 

fn from(val: GrowableBinary<'a, O>) -> BinaryArray<O>

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

fn from_iter<I>(iter: I) -> BinaryArray<O> where
    I: IntoIterator<Item = Option<P>>, 

Creates a value from an iterator.

impl<O> GenericBinaryArray<O> for BinaryArray<O> where
    O: Offset, 

fn values(&self) -> &[u8]

The values of the array

fn offsets(&self) -> &[O]

The offsets of the array

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

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

The type of the elements being iterated over.

type IntoIter = ZipValidity<'a, &'a [u8], BinaryValueIter<'a, O>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <&'a BinaryArray<O> as IntoIterator>::IntoIter

Creates an iterator from a value.

impl<'_, O> PartialEq<&'_ (dyn Array + '_)> for BinaryArray<O> where
    O: Offset, 

fn eq(&self, other: &&dyn Array) -> 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 !=.

impl<O> PartialEq<BinaryArray<O>> for BinaryArray<O> where
    O: Offset, 

fn eq(&self, other: &BinaryArray<O>) -> 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 !=.