Struct VarBinArray

pub struct VarBinArray { /* private fields */ }

Implementations

impl VarBinArray

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

pub fn offsets(&self) -> &ArrayRef

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, ArrayRef, 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 ArrayCanonicalImpl for VarBinArray

fn _to_canonical(&self) -> VortexResult<Canonical>

Returns the canonical representation of the array.

fn _append_to_builder(&self, builder: &mut dyn ArrayBuilder) -> VortexResult<()>

Writes the array into the canonical builder.

impl ArrayComputeImpl for VarBinArray

const FILTER: Option<KernelRef>

fn _find_kernel(&self, _compute_fn: &dyn ComputeFn) -> Option<KernelRef>

Fallback implementation to lookup compute kernels at runtime.

impl ArrayImpl for VarBinArray

type Encoding = VarBinEncoding

fn _len(&self) -> usize

fn _dtype(&self) -> &DType

fn _vtable(&self) -> VTableRef

fn _with_children(&self, children: &[ArrayRef]) -> VortexResult<Self>

Replace the children of this array with the given arrays.

impl ArrayStatisticsImpl for VarBinArray

fn _stats_ref(&self) -> StatsSetRef<'_>

impl ArrayValidityImpl for VarBinArray

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

Returns whether the index item is valid.

fn _all_valid(&self) -> VortexResult<bool>

Returns whether the array is all valid.

fn _all_invalid(&self) -> VortexResult<bool>

Returns whether the array is all invalid.

fn _validity_mask(&self) -> VortexResult<Mask>

Returns the canonical validity mask for the array.

fn _valid_count(&self) -> VortexResult<usize>

Returns the number of valid elements in the array.

fn _invalid_count(&self) -> VortexResult<usize>

Returns the number of invalid elements in the array.

impl ArrayVariantsImpl for VarBinArray

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

Downcasts the array for utf8-specific behavior.

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

Downcasts the array for binary-specific behavior.

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

Downcasts the array for null-specific behavior.

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

Downcasts the array for bool-specific behavior.

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

Downcasts the array for primitive-specific behavior.

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

Downcasts the array for struct-specific behavior.

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

Downcasts the array for list-specific behavior.

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

Downcasts the array for extension-specific behavior.

impl ArrayVisitorImpl<RkyvMetadata<VarBinMetadata>> for VarBinArray

fn _visit_buffers(&self, visitor: &mut dyn ArrayBufferVisitor)

fn _visit_children(&self, visitor: &mut dyn ArrayChildVisitor)

fn _metadata(&self) -> RkyvMetadata<VarBinMetadata>

fn _nbuffers(&self) -> usize

fn _nchildren(&self) -> usize

impl CastFn<&VarBinArray> for VarBinEncoding

fn cast(&self, array: &VarBinArray, dtype: &DType) -> VortexResult<ArrayRef>

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

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 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 IsConstantFn<&VarBinArray> for VarBinEncoding

fn is_constant( &self, array: &VarBinArray, _opts: &IsConstantOpts, ) -> VortexResult<Option<bool>>

Preconditions

impl IsSortedFn<&VarBinArray> for VarBinEncoding

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

Preconditions

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

impl MaskFn<&VarBinArray> for VarBinEncoding

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

Replace masked values with null in array.

impl MinMaxFn<&VarBinArray> for VarBinEncoding

fn min_max(&self, array: &VarBinArray) -> VortexResult<Option<MinMaxResult>>

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

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

fn take( &self, array: &VarBinArray, indices: &dyn Array, ) -> VortexResult<ArrayRef>

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

fn take_into( &self, array: A, indices: &dyn Array, builder: &mut dyn ArrayBuilder, ) -> VortexResult<()>

Has the same semantics as Self::take but materializes the result into the provided builder.

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 TryFrom<Arc<dyn Array>> for VarBinArray

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(value: ArrayRef) -> Result<Self, Self::Error>

Performs the conversion.

impl UncompressedSizeFn<&VarBinArray> for VarBinEncoding

fn uncompressed_size(&self, array: &VarBinArray) -> VortexResult<usize>

Compute the approximated uncompressed size of the array, in bytes.

impl BinaryArrayTrait for VarBinArray

impl Utf8ArrayTrait for VarBinArray