Struct vortex_array::array::VarBinViewArray

pub struct VarBinViewArray(/* private fields */);

Implementations

impl VarBinViewArray

pub fn maybe_from(data: impl AsRef<ArrayData>) -> Option<Self>

Optionally downcast an ArrayData instance to a specific encoding.

Preferred in cases where a backtrace isn’t needed, like when trying multiple encoding to go down different code paths.

impl VarBinViewArray

pub fn try_new( views: ArrayData, buffers: Vec<ArrayData>, 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) -> ArrayData

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) -> ArrayData

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 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 AsRef<ArrayData> for VarBinViewArray

fn as_ref(&self) -> &ArrayData

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<'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 IntoArrayData for VarBinViewArray

fn into_array(self) -> ArrayData

impl IntoCanonical for VarBinViewArray

fn into_canonical(self) -> VortexResult<Canonical>

fn into_arrow(self) -> VortexResult<ArrayRef>

where Self: Sized,

impl ScalarAtFn<VarBinViewArray> for VarBinViewEncoding

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

impl SliceFn<VarBinViewArray> for VarBinViewEncoding

fn slice( &self, array: &VarBinViewArray, start: usize, stop: usize, ) -> VortexResult<ArrayData>

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 StatisticsVTable<VarBinViewArray> for VarBinViewEncoding

fn compute_statistics( &self, array: &VarBinViewArray, stat: Stat, ) -> VortexResult<StatsSet>

Compute the requested statistic. Can return additional stats.

impl TakeFn<VarBinViewArray> for VarBinViewEncoding

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

fn take( &self, array: &VarBinViewArray, indices: &ArrayData, ) -> VortexResult<ArrayData>

Create a new array by taking the values from the array at the given indices.

unsafe fn take_unchecked( &self, array: &VarBinViewArray, indices: &ArrayData, ) -> VortexResult<ArrayData>

Create a new array by taking the values from the array at the given indices.

impl<'a> TryFrom<&'a ArrayData> for &'a VarBinViewArray

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(data: &'a ArrayData) -> VortexResult<Self>

Performs the conversion.

impl TryFrom<ArrayData> for VarBinViewArray

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(data: ArrayData) -> VortexResult<Self>

Performs the conversion.

impl ValidityVTable<VarBinViewArray> for VarBinViewEncoding

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

fn logical_validity(&self, array: &VarBinViewArray) -> LogicalValidity

impl VariantsVTable<VarBinViewArray> for VarBinViewEncoding

fn as_utf8_array<'a>( &self, array: &'a VarBinViewArray, ) -> Option<&'a dyn Utf8ArrayTrait>

fn as_binary_array<'a>( &self, array: &'a VarBinViewArray, ) -> Option<&'a dyn BinaryArrayTrait>

fn as_null_array<'a>(&self, _array: &'a Array) -> Option<&'a dyn NullArrayTrait>

fn as_bool_array<'a>(&self, _array: &'a Array) -> Option<&'a dyn BoolArrayTrait>

fn as_primitive_array<'a>( &self, _array: &'a Array, ) -> Option<&'a dyn PrimitiveArrayTrait>

fn as_struct_array<'a>( &self, _array: &'a Array, ) -> Option<&'a dyn StructArrayTrait>

fn as_list_array<'a>(&self, _array: &'a Array) -> Option<&'a dyn ListArrayTrait>

fn as_extension_array<'a>( &self, _array: &'a Array, ) -> Option<&'a dyn ExtensionArrayTrait>

impl VisitorVTable<VarBinViewArray> for VarBinViewEncoding

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

impl ArrayTrait for VarBinViewArray

impl BinaryArrayTrait for VarBinViewArray

impl Utf8ArrayTrait for VarBinViewArray