Struct VarBinViewArray

pub struct VarBinViewArray { /* private fields */ }

Implementations

impl VarBinViewArray

pub fn try_new( views: Buffer<BinaryView>, buffers: Vec<ByteBuffer>, dtype: DType, validity: Validity, ) -> VortexResult<Self>

pub fn nbuffers(&self) -> usize

Number of raw string data buffers held by this array.

pub fn views(&self) -> &Buffer<BinaryView>

Access to the primitive views buffer.

Variable-sized binary view buffer 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 bytes_at(&self, index: usize) -> ByteBuffer

Access value bytes at a given index

Will return a bytebuffer pointing to the underlying data without performing a copy

pub fn buffer(&self, idx: usize) -> &ByteBuffer

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) -> &[ByteBuffer]

Iterate over the underlying raw data buffers, not including the views buffer.

pub fn validity(&self) -> &Validity

Validity of the array

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

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 ArrayCanonicalImpl for VarBinViewArray

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 ArrayImpl for VarBinViewArray

type Encoding = VarBinViewEncoding

fn _len(&self) -> usize

fn _dtype(&self) -> &DType

fn _vtable(&self) -> VTableRef

impl ArrayStatisticsImpl for VarBinViewArray

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

impl ArrayValidityImpl for VarBinViewArray

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 VarBinViewArray

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

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

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

fn _metadata(&self) -> EmptyMetadata

fn _nbuffers(&self) -> usize

fn _nchildren(&self) -> usize

impl CastFn<&VarBinViewArray> for VarBinViewEncoding

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

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 IsConstantFn<&VarBinViewArray> for VarBinViewEncoding

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

Preconditions

impl MaskFn<&VarBinViewArray> for VarBinViewEncoding

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

Replace masked values with null in array.

impl MinMaxFn<&VarBinViewArray> for VarBinViewEncoding

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

impl ScalarAtFn<&VarBinViewArray> for VarBinViewEncoding

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

impl SerdeVTable<&VarBinViewArray> for VarBinViewEncoding

fn decode( &self, parts: &ArrayParts, ctx: &ArrayContext, dtype: DType, len: usize, ) -> VortexResult<ArrayRef>

Decode an ArrayParts into an ArrayRef of this encoding.

impl SliceFn<&VarBinViewArray> for VarBinViewEncoding

fn slice( &self, array: &VarBinViewArray, 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 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: &dyn Array, ) -> VortexResult<ArrayRef>

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

fn take_into( &self, array: &VarBinViewArray, 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<&VarBinViewArray> for VarBinViewEncoding

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

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

fn preferred_arrow_data_type(&self, _array: A) -> 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.

impl TryFrom<Arc<dyn Array>> for VarBinViewArray

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

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

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

impl BinaryArrayTrait for VarBinViewArray

impl Utf8ArrayTrait for VarBinViewArray