Struct OpaqueEncoding

pub struct OpaqueEncoding(pub u16);

An encoding of an array that we cannot interpret.

Vortex allows for pluggable encodings. This can lead to issues when one process produces a file using a custom encoding, and then another process without knowledge of the encoding attempts to read it.

OpaqueEncoding allows deserializing these arrays. Many common operations will fail, but it allows deserialization and introspection in a type-erased manner on the children and metadata.

We hold the original 16-bit encoding ID for producing helpful error messages.

Tuple Fields

0: u16

Trait Implementations

impl CanonicalVTable<Array> for OpaqueEncoding

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

impl Clone for OpaqueEncoding

fn clone(&self) -> OpaqueEncoding

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl ComputeVTable for OpaqueEncoding

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 filter_fn(&self) -> Option<&dyn FilterFn<Array>>

Filter an array with a given mask.

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 scalar_at_fn(&self) -> Option<&dyn ScalarAtFn<Array>>

Single item indexing on Vortex 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.

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.

impl Debug for OpaqueEncoding

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

Formats the value using the given formatter.

impl EncodingVTable for OpaqueEncoding

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 MetadataVTable<Array> for OpaqueEncoding

fn validate_metadata(&self, _metadata: Option<&[u8]>) -> VortexResult<()>

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

impl StatisticsVTable<Array> for OpaqueEncoding

fn compute_statistics( &self, _array: &Array, _stat: Stat, ) -> VortexResult<StatsSet>

Compute the requested statistic. Can return additional stats.

impl ValidateVTable<Array> for OpaqueEncoding

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

impl ValidityVTable<Array> for OpaqueEncoding

fn is_valid(&self, _array: &Array, _index: usize) -> VortexResult<bool>

Returns whether the index item is valid.

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

Returns whether the array is all valid.

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

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

Returns the number of invalid elements in the array.

impl VariantsVTable<Array> for OpaqueEncoding

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_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<Array> for OpaqueEncoding

fn accept( &self, _array: &Array, _visitor: &mut dyn ArrayVisitor, ) -> VortexResult<()>

impl Copy for OpaqueEncoding