Struct StructEncoding

pub struct StructEncoding;

The array encoding

Implementations

impl StructEncoding

pub const fn vtable() -> VTableRef

Trait Implementations

impl CanonicalVTable<StructArray> for StructEncoding

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

StructEncoding is the canonical form for a DType::Struct array, so return self.

impl ComputeVTable for StructEncoding

fn filter_fn(&self) -> Option<&dyn FilterFn<Array>>

Filter an array with a given mask.

fn scalar_at_fn(&self) -> Option<&dyn ScalarAtFn<Array>>

Single item indexing on Vortex arrays.

fn slice_fn(&self) -> Option<&dyn SliceFn<Array>>

Perform zero-copy slicing of an array.

fn take_fn(&self) -> Option<&dyn TakeFn<Array>>

Take a set of indices from an array. This often forces allocations and decoding of the receiver.

fn to_arrow_fn(&self) -> Option<&dyn ToArrowFn<Array>>

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

fn binary_boolean_fn(&self) -> Option<&dyn BinaryBooleanFn<Array>>

Implementation of binary boolean logic operations.

fn binary_numeric_fn(&self) -> Option<&dyn BinaryNumericFn<Array>>

Implementation of binary numeric operations.

fn cast_fn(&self) -> Option<&dyn CastFn<Array>>

Implemented for arrays that can be casted to different types.

fn compare_fn(&self) -> Option<&dyn CompareFn<Array>>

Binary operator implementation for arrays against other arrays.

fn fill_forward_fn(&self) -> Option<&dyn FillForwardFn<Array>>

Array function that returns new arrays a non-null value is repeated across runs of nulls.

fn fill_null_fn(&self) -> Option<&dyn FillNullFn<Array>>

Fill null values with given desired value. Resulting array is NonNullable

fn invert_fn(&self) -> Option<&dyn InvertFn<Array>>

Invert a boolean array. Converts true -> false, false -> true, null -> null.

fn like_fn(&self) -> Option<&dyn LikeFn<Array>>

Perform a SQL LIKE operation on two arrays.

fn search_sorted_fn(&self) -> Option<&dyn SearchSortedFn<Array>>

Perform a search over an ordered array.

fn search_sorted_usize_fn(&self) -> Option<&dyn SearchSortedUsizeFn<Array>>

Perform a search over an ordered array.

impl Debug for StructEncoding

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

Formats the value using the given formatter.

impl Encoding for StructEncoding

const ID: EncodingId

type Array = StructArray

type Metadata = RkyvMetadata<StructMetadata>

impl EncodingVTable for StructEncoding

fn id(&self) -> EncodingId

Return the ID for this encoding implementation.

fn as_any(&self) -> &dyn Any

Return a reference to this encoding as a dyn Any for type erasure.

impl FilterFn<StructArray> for StructEncoding

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

Filter an array by the provided predicate.

impl ScalarAtFn<StructArray> for StructEncoding

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

impl SliceFn<StructArray> for StructEncoding

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

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

Compute the requested statistic. Can return additional stats.

impl TakeFn<StructArray> for StructEncoding

fn take(&self, array: &StructArray, 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<StructArray> for StructEncoding

fn to_arrow( &self, array: &StructArray, 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 ValidateVTable<StructArray> for StructEncoding

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

impl ValidityVTable<StructArray> for StructEncoding

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

Returns whether the index item is valid.

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

Returns whether the array is all valid.

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

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

Returns the number of invalid elements in the array.

impl VariantsVTable<StructArray> for StructEncoding

fn as_struct_array<'a>( &self, array: &'a StructArray, ) -> Option<&'a dyn StructArrayTrait>

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_utf8_array<'a>(&self, _array: &'a Array) -> Option<&'a dyn Utf8ArrayTrait>

fn as_binary_array<'a>( &self, _array: &'a Array, ) -> Option<&'a dyn BinaryArrayTrait>

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<StructArray> for StructEncoding

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