Struct VarBinArray

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

Implementations

impl VarBinArray

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

Optionally downcast an Array 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: Array, bytes: ByteBuffer, dtype: DType, validity: Validity, ) -> VortexResult<Self>

pub fn offsets(&self) -> Array

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, Array, Validity)

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

Methods from Deref<Target = Array>

pub fn vtable(&self) -> &VTableRef

Return the array’s encoding VTable.

pub fn encoding(&self) -> EncodingId

Return the array’s encoding ID.

pub fn len(&self) -> usize

Returns the number of logical elements in the array.

pub fn is_empty(&self) -> bool

Check whether the array has any data

pub fn dtype(&self) -> &DType

Return the array’s dtype

pub fn is_canonical(&self) -> bool

Whether the array is of a canonical encoding.

pub fn is_arrow(&self) -> bool

Whether the array is fully zero-copy to Arrow (including children). This means any nested types, like Structs, Lists, and Extensions are not present.

pub fn is_constant(&self) -> bool

Return whether the array is constant.

pub fn as_constant(&self) -> Option<Scalar>

Return scalar value of this array if the array is constant

pub fn child<'a>( &'a self, idx: usize, dtype: &'a DType, len: usize, ) -> VortexResult<Self>

pub fn children(&self) -> Vec<Array>

Returns a Vec of Arrays with all the array’s child arrays.

pub fn named_children(&self) -> Vec<(String, Array)>

Returns a Vec of Arrays with all the array’s child arrays.

pub fn nchildren(&self) -> usize

Returns the number of child arrays

pub fn depth_first_traversal(&self) -> ArrayChildrenIterator

pub fn cumulative_nbuffers(&self) -> usize

Count the number of cumulative buffers encoded by self.

pub fn all_buffer_offsets(&self, alignment: usize) -> Vec<u64>

Return the buffer offsets and the total length of all buffers, assuming the given alignment. This includes all child buffers.

pub fn metadata_bytes(&self) -> Option<&[u8]>

pub fn nbuffers(&self) -> usize

pub fn byte_buffer(&self, index: usize) -> Option<&ByteBuffer>

pub fn byte_buffers(&self) -> impl Iterator<Item = ByteBuffer> + '_

pub fn is_encoding(&self, id: EncodingId) -> bool

Checks whether array is of a given encoding.

pub fn try_downcast_ref<E: Encoding>(&self) -> VortexResult<(&E::Array, &E)>

where for<'a> &'a E::Array: TryFrom<&'a Array, Error = VortexError>,

pub fn nbytes(&self) -> usize

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

pub fn statistics(&self) -> &(dyn Statistics + '_)

pub fn inherit_statistics(&self, parent: &dyn Statistics)

pub fn tree_display(&self) -> TreeDisplayWrapper<'_>

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

Return whether the element at the given index is valid (true) or null (false).

pub fn all_valid(&self) -> VortexResult<bool>

Return whether all elements in the array are valid.

pub fn null_count(&self) -> VortexResult<usize>

Return the number of null elements in the array.

pub fn validity_mask(&self) -> VortexResult<Mask>

Return the canonical validity of the array as a Mask.

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

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

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

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

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

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

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

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

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

fn as_ref(&self) -> &Array

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

impl CanonicalVTable<VarBinArray> for VarBinEncoding

fn into_canonical(&self, array: VarBinArray) -> VortexResult<Canonical>

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: &Array, operator: Operator, ) -> VortexResult<Option<Array>>

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

type Target = Array

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl FilterFn<VarBinArray> for VarBinEncoding

fn filter(&self, array: &VarBinArray, mask: &Mask) -> VortexResult<Array>

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

fn into_array(self) -> Array

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<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 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: &Array) -> VortexResult<Array>

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

unsafe fn take_unchecked( &self, array: &A, indices: &Array, ) -> VortexResult<Array>

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

impl ToArrowFn<VarBinArray> for VarBinEncoding

fn preferred_arrow_data_type( &self, array: &VarBinArray, ) -> VortexResult<Option<DataType>>

Return the preferred Arrow DataType of the encoding, or None of the canonical DataType for the array’s Vortex vortex_dtype::DType should be used.

fn to_arrow( &self, array: &VarBinArray, data_type: &DataType, ) -> VortexResult<Option<ArrayRef>>

Convert the array to an Arrow array of the given type.

impl<'a> TryFrom<&'a Array> for &'a VarBinArray

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Array> for VarBinArray

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(data: Array) -> 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) -> VortexResult<bool>

Returns whether the index item is valid.

fn all_valid(&self, array: &VarBinArray) -> VortexResult<bool>

Returns whether the array is all valid.

fn validity_mask(&self, array: &VarBinArray) -> VortexResult<Mask>

fn invalid_count(&self, array: &Array) -> VortexResult<usize>

Returns the number of invalid elements in the array.

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

impl Utf8ArrayTrait for VarBinArray