Struct VarBinViewArray

pub struct VarBinViewArray { /* private fields */ }

Implementations

impl VarBinViewArray

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

impl VarBinViewArray

pub fn try_new( views: Array, buffers: Vec<Array>, dtype: DType, validity: Validity, ) -> VortexResult<Self>

pub fn buffer_count(&self) -> usize

Number of raw string data buffers held by this array.

pub fn binary_views(&self) -> VortexResult<Views>

Access to the underlying views child array as a slice of BinaryView structures.

This is useful for iteration over the values, as well as for applying filters that may only require hitting the prefixes or inline strings.

pub fn view_at(&self, index: usize) -> VortexResult<BinaryView>

Retrieve a binary view at a specific index.

If you will be calling this method many times, it’s recommended that you instead use the iterator provided by binary_views.

pub fn views(&self) -> Array

Access to the primitive views array.

Variable-sized binary view arrays contain a “view” child array, with 16-byte entries that contain either a pointer into one of the array’s owned buffers OR an inlined copy of the string (if the string has 12 bytes or fewer).

pub fn buffer(&self, idx: usize) -> Array

Access one of the backing data buffers.

Panics

This method panics if the provided index is out of bounds for the set of buffers provided at construction time.

pub fn buffers(&self) -> Buffers<'_>

Retrieve an iterator over the raw data buffers. These are the BYTE buffers that make up the array’s contents.

Example

use vortex_array::array::VarBinViewArray;
let array = VarBinViewArray::from_iter_str(["a", "b", "c"]);
array.buffers().for_each(|block| {
    // Do something with the `block`
});

pub fn validity(&self) -> Validity

pub fn from_iter<T: AsRef<[u8]>, I: IntoIterator<Item = Option<T>>>( iter: I, dtype: DType, ) -> Self

Accumulate an iterable set of values into our type here.

pub fn from_iter_str<T: AsRef<str>, I: IntoIterator<Item = T>>(iter: I) -> Self

pub fn from_iter_nullable_str<T: AsRef<str>, I: IntoIterator<Item = Option<T>>>( iter: I, ) -> Self

pub fn from_iter_bin<T: AsRef<[u8]>, I: IntoIterator<Item = T>>(iter: I) -> Self

pub fn from_iter_nullable_bin<T: AsRef<[u8]>, I: IntoIterator<Item = Option<T>>>( iter: I, ) -> Self

pub fn bytes_at(&self, index: usize) -> VortexResult<Vec<u8>>

Trait Implementations

impl AcceptArrayVisitor for VarBinViewArray

fn accept(&self, visitor: &mut dyn ArrayVisitor) -> VortexResult<()>

impl ArrayAccessor<[u8]> for VarBinViewArray

fn with_iterator<F: for<'a> FnOnce(&mut dyn Iterator<Item = Option<&'a [u8]>>) -> R, R>( &self, f: F, ) -> VortexResult<R>

Iterate over each element of the array, in-order.

impl ArrayCompute for VarBinViewArray

fn compare( &self, other: &Array, operator: Operator, ) -> Option<VortexResult<Array>>

Binary operator implementation for arrays against other arrays.

fn scalar_at(&self) -> Option<&dyn ScalarAtFn>

Single item indexing on Vortex arrays.

fn slice(&self) -> Option<&dyn SliceFn>

Perform zero-copy slicing of an array.

fn take(&self) -> Option<&dyn TakeFn>

Take a set of indices from an array. This often forces allocations and decoding of the receiver.

fn cast(&self) -> Option<&dyn CastFn>

Implemented for arrays that can be casted to different types.

fn fill_forward(&self) -> Option<&dyn FillForwardFn>

Array function that returns new arrays a non-null value is repeated across runs of nulls.

fn filter(&self) -> Option<&dyn FilterFn>

Filtering function on arrays of predicates.

fn subtract_scalar(&self) -> Option<&dyn SubtractScalarFn>

Broadcast subtraction of scalar from Vortex array.

fn search_sorted(&self) -> Option<&dyn SearchSortedFn>

Perform a search over an ordered array.

fn and(&self) -> Option<&dyn AndFn>

Perform an Arrow-style boolean AND operation over two arrays

fn and_kleene(&self) -> Option<&dyn AndFn>

Perform a Kleene-style boolean AND operation over two arrays

fn or(&self) -> Option<&dyn OrFn>

Perform an Arrow-style boolean OR operation over two arrays

fn or_kleene(&self) -> Option<&dyn OrFn>

Perform a Kleene-style boolean OR operation over two arrays

impl ArrayStatisticsCompute for VarBinViewArray

fn compute_statistics(&self, _stat: Stat) -> VortexResult<StatsSet>

Compute the requested statistic. Can return additional stats.

impl ArrayTrait for VarBinViewArray

fn nbytes(&self) -> usize

Total size of the array in bytes, including all children and buffers.

impl ArrayValidity for VarBinViewArray

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

fn logical_validity(&self) -> LogicalValidity

impl ArrayVariants for VarBinViewArray

fn as_utf8_array(&self) -> Option<&dyn Utf8ArrayTrait>

fn as_binary_array(&self) -> Option<&dyn BinaryArrayTrait>

fn as_null_array(&self) -> Option<&dyn NullArrayTrait>

fn as_null_array_unchecked(&self) -> &dyn NullArrayTrait

fn as_bool_array(&self) -> Option<&dyn BoolArrayTrait>

fn as_bool_array_unchecked(&self) -> &dyn BoolArrayTrait

fn as_primitive_array(&self) -> Option<&dyn PrimitiveArrayTrait>

fn as_primitive_array_unchecked(&self) -> &dyn PrimitiveArrayTrait

fn as_utf8_array_unchecked(&self) -> &dyn Utf8ArrayTrait

fn as_binary_array_unchecked(&self) -> &dyn BinaryArrayTrait

fn as_struct_array(&self) -> Option<&dyn StructArrayTrait>

fn as_struct_array_unchecked(&self) -> &dyn StructArrayTrait

fn as_list_array(&self) -> Option<&dyn ListArrayTrait>

fn as_list_array_unchecked(&self) -> &dyn ListArrayTrait

fn as_extension_array(&self) -> Option<&dyn ExtensionArrayTrait>

fn as_extension_array_unchecked(&self) -> &dyn ExtensionArrayTrait

impl AsRef<Array> for VarBinViewArray

fn as_ref(&self) -> &Array

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for VarBinViewArray

fn clone(&self) -> VarBinViewArray

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VarBinViewArray

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

Formats the value using the given formatter.

impl From<TypedArray<VarBinView>> for VarBinViewArray

fn from(typed: TypedArray<VarBinView>) -> Self

Converts to this type from the input type.

impl From<VarBinViewArray> for Array

fn from(value: VarBinViewArray) -> Array

Converts to this type from the input type.

impl<'a> FromIterator<Option<&'a [u8]>> for VarBinViewArray

fn from_iter<T: IntoIterator<Item = Option<&'a [u8]>>>(iter: T) -> Self

Creates a value from an iterator.

impl<'a> FromIterator<Option<&'a str>> for VarBinViewArray

fn from_iter<T: IntoIterator<Item = Option<&'a str>>>(iter: T) -> Self

Creates a value from an iterator.

impl FromIterator<Option<String>> for VarBinViewArray

fn from_iter<T: IntoIterator<Item = Option<String>>>(iter: T) -> Self

Creates a value from an iterator.

impl FromIterator<Option<Vec<u8>>> for VarBinViewArray

fn from_iter<T: IntoIterator<Item = Option<Vec<u8>>>>(iter: T) -> Self

Creates a value from an iterator.

impl GetArrayMetadata for VarBinViewArray

fn metadata(&self) -> Arc<dyn ArrayMetadata>

impl IntoArray for VarBinViewArray

fn into_array(self) -> Array

impl IntoCanonical for VarBinViewArray

fn into_canonical(self) -> VortexResult<Canonical>

impl MaybeCompareFn for VarBinViewArray

fn maybe_compare( &self, other: &Array, operator: Operator, ) -> Option<VortexResult<Array>>

impl ScalarAtFn for VarBinViewArray

fn scalar_at(&self, index: usize) -> VortexResult<Scalar>

fn scalar_at_unchecked(&self, index: usize) -> Scalar

impl SliceFn for VarBinViewArray

fn slice(&self, start: usize, stop: usize) -> VortexResult<Array>

Return a zero-copy slice of an array, between start (inclusive) and end (exclusive). If start >= stop, returns an empty array of the same type as self. Assumes that start or stop are out of bounds, may panic otherwise.

impl TakeFn for VarBinViewArray

Take involves creating a new array that references the old array, just with the given set of views.

fn take(&self, indices: &Array) -> VortexResult<Array>

impl ToArray for VarBinViewArray

fn to_array(&self) -> Array

impl TryFrom<&Array> for VarBinViewArray

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(array: &Array) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Array> for VarBinViewArray

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(array: Array) -> Result<Self, Self::Error>

Performs the conversion.

impl BinaryArrayTrait for VarBinViewArray

impl Utf8ArrayTrait for VarBinViewArray