Struct VarBinArray

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

Implementations

impl VarBinArray

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 VarBinArray

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

pub fn offsets(&self) -> ArrayData

pub fn validity(&self) -> Validity

pub fn bytes(&self) -> ByteBuffer

Access the value bytes child buffer

Note

Bytes child buffer 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 the offset child array.

pub fn sliced_bytes(&self) -> ByteBuffer

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) -> VortexResult<usize>

Get value offset at a given index

Note: There’s 1 more offsets than the elements in the array, thus last offset is at array length index

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

Access value bytes at a given index

Will return buffer referncing underlying data without performing a copy

pub fn into_parts(self) -> (DType, ByteBuffer, ArrayData, Validity)

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

Trait Implementations

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

fn as_ref(&self) -> &ArrayData

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 CompareFn<VarBinArray> for VarBinEncoding

fn compare( &self, lhs: &VarBinArray, rhs: &ArrayData, operator: Operator, ) -> VortexResult<Option<ArrayData>>

Compares two arrays and returns a new boolean array with the result of the comparison. Or, returns None if comparison is not supported for these arrays.

impl Debug for VarBinArray

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

Formats the value using the given formatter.

impl FilterFn<VarBinArray> for VarBinEncoding

fn filter( &self, array: &VarBinArray, mask: &FilterMask, ) -> VortexResult<ArrayData>

Filter an array by the provided predicate.

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

fn into_array(self) -> ArrayData

impl IntoCanonical for VarBinArray

fn into_canonical(self) -> VortexResult<Canonical>

fn into_arrow(self) -> VortexResult<ArrayRef>

fn into_arrow_with_data_type( self, data_type: &DataType, ) -> VortexResult<ArrayRef>

impl ScalarAtFn<VarBinArray> for VarBinEncoding

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

impl SliceFn<VarBinArray> for VarBinEncoding

fn slice( &self, array: &VarBinArray, 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<VarBinArray> for VarBinEncoding

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

Compute the requested statistic. Can return additional stats.

impl TakeFn<VarBinArray> for VarBinEncoding

fn take( &self, array: &VarBinArray, 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: &Array, 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 VarBinArray

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 VarBinArray

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl ValidateVTable<VarBinArray> for VarBinEncoding

fn validate(&self, _array: &Array) -> VortexResult<()>

impl ValidityVTable<VarBinArray> for VarBinEncoding

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

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

impl VariantsVTable<VarBinArray> for VarBinEncoding

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

fn as_binary_array<'a>( &self, array: &'a VarBinArray, ) -> 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<VarBinArray> for VarBinEncoding

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

impl ArrayTrait for VarBinArray

impl BinaryArrayTrait for VarBinArray

impl Utf8ArrayTrait for VarBinArray