Struct VarBinArray

pub struct VarBinArray { /* private fields */ }

Implementations

impl VarBinArray

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

impl VarBinArray

pub fn try_new( offsets: Array, bytes: Array, dtype: DType, validity: Validity, ) -> VortexResult<Self>

pub fn offsets(&self) -> Array

pub fn first_offset<T: NativePType + for<'a> TryFrom<&'a Scalar, Error = VortexError>>( &self, ) -> VortexResult<T>

pub fn bytes(&self) -> Array

Access the value bytes child array

Note

Bytes child array is never sliced when the array is sliced so this can include values that are not logically present in the array. Users should prefer sliced_bytes unless they’re resolving values via offset child array.

pub fn validity(&self) -> Validity

pub fn sliced_bytes(&self) -> VortexResult<Array>

Access value bytes child array limited to values that are logically present in the array unlike bytes.

pub fn from_vec<T: AsRef<[u8]>>(vec: Vec<T>, dtype: DType) -> Self

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

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

pub fn offset_at(&self, index: usize) -> usize

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

pub fn into_parts(self) -> (DType, Array, Array, Validity)

Consumes self, returning a tuple containing the DType, the bytes array, the offsets array, and the validity.

Trait Implementations

impl AcceptArrayVisitor for VarBinArray

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

impl ArrayAccessor<[u8]> for VarBinArray

fn with_iterator<F, R>(&self, f: F) -> VortexResult<R>

where F: for<'a> FnOnce(&mut dyn Iterator<Item = Option<&'a [u8]>>) -> R,

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

impl ArrayCompute for VarBinArray

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

Binary operator implementation for arrays against other arrays.

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

Filtering function on arrays of predicates.

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 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 VarBinArray

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

Compute the requested statistic. Can return additional stats.

impl ArrayTrait for VarBinArray

fn nbytes(&self) -> usize

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

impl ArrayValidity for VarBinArray

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

fn logical_validity(&self) -> LogicalValidity

impl ArrayVariants for VarBinArray

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 VarBinArray

fn as_ref(&self) -> &Array

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

impl Clone for VarBinArray

fn clone(&self) -> VarBinArray

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VarBinArray

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

Formats the value using the given formatter.

impl FilterFn for VarBinArray

fn filter(&self, predicate: &Array) -> VortexResult<Array>

Filter an array by the provided predicate.

impl From<TypedArray<VarBin>> for VarBinArray

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

Converts to this type from the input type.

impl From<VarBinArray> for Array

fn from(value: VarBinArray) -> Array

Converts to this type from the input type.

impl From<Vec<&[u8]>> for VarBinArray

fn from(value: Vec<&[u8]>) -> Self

Converts to this type from the input type.

impl From<Vec<&str>> for VarBinArray

fn from(value: Vec<&str>) -> Self

Converts to this type from the input type.

impl From<Vec<String>> for VarBinArray

fn from(value: Vec<String>) -> Self

Converts to this type from the input type.

impl From<Vec<Vec<u8>>> for VarBinArray

fn from(value: Vec<Vec<u8>>) -> Self

Converts to this type from the input type.

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

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 VarBinArray

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

Creates a value from an iterator.

impl FromIterator<Option<String>> for VarBinArray

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

Creates a value from an iterator.

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

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

Creates a value from an iterator.

impl GetArrayMetadata for VarBinArray

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

impl IntoArray for VarBinArray

fn into_array(self) -> Array

impl IntoCanonical for VarBinArray

fn into_canonical(self) -> VortexResult<Canonical>

impl MaybeCompareFn for VarBinArray

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

impl ScalarAtFn for VarBinArray

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

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

impl SliceFn for VarBinArray

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 VarBinArray

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

impl ToArray for VarBinArray

fn to_array(&self) -> Array

impl TryFrom<&Array> for VarBinArray

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 VarBinArray

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 VarBinArray

impl Utf8ArrayTrait for VarBinArray