Struct ArrayAdapter 

pub struct ArrayAdapter<V: VTable>(/* private fields */);

Adapter struct used to lift the VTable trait into an object-safe Array implementation.

Since this is a unit struct with repr(transparent), we are able to turn un-adapted array structs into [dyn Array] using some cheeky casting inside std::ops::Deref and AsRef. See the vtable! macro for more details.

Implementations

impl<V: VTable> ArrayAdapter<V>

pub fn as_inner(&self) -> &V::Array

Provide a reference to the underlying array held within the adapter.

pub fn into_inner(self) -> V::Array

Unwrap into the inner array type, consuming the adapter.

Trait Implementations

impl<V: VTable> Array for ArrayAdapter<V>

fn as_any(&self) -> &dyn Any

Returns the array as a reference to a generic Any trait object.

fn to_array(&self) -> ArrayRef

Returns the array as an ArrayRef.

fn len(&self) -> usize

Returns the length of the array.

fn dtype(&self) -> &DType

Returns the logical Vortex DType of the array.

fn encoding(&self) -> EncodingRef

Returns the encoding of the array.

fn encoding_id(&self) -> EncodingId

Returns the encoding ID of the array.

fn slice(&self, start: usize, stop: usize) -> ArrayRef

Performs a constant-time slice of the array.

fn scalar_at(&self, index: usize) -> Scalar

Fetch the scalar at the given index.

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

Returns whether the item at index is valid.

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

Returns whether the item at index is invalid.

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

Returns whether all items in the array are valid.

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

Returns whether the array is all invalid.

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.

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

Returns the canonical validity mask for the array.

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.

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

Returns the statistics of the array.

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

Replaces the children of the array with the given array references.

fn invoke( &self, compute_fn: &ComputeFn, args: &InvocationArgs<'_>, ) -> VortexResult<Option<Output>>

Optionally invoke a kernel for the given compute function.

fn to_operator(&self) -> VortexResult<Option<Rc<dyn Operator>>>

Convert the array to a pipeline operator if supported by the encoding.

fn is_empty(&self) -> bool

Returns whether the array is empty (has zero rows).

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

Returns whether the array is of the given encoding.

fn is_arrow(&self) -> bool

Returns whether this array is an arrow encoding.

fn is_canonical(&self) -> bool

Whether the array is of a canonical encoding.

impl<V: VTable> ArrayVisitor for ArrayAdapter<V>

fn children(&self) -> Vec<ArrayRef>

Returns the children of the array.

fn nchildren(&self) -> usize

Returns the number of children of the array.

fn children_names(&self) -> Vec<String>

Returns the names of the children of the array.

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

Returns the array’s children with their names.

fn buffers(&self) -> Vec<ByteBuffer>

Returns the buffers of the array.

fn nbuffers(&self) -> usize

Returns the number of buffers of the array.

fn metadata(&self) -> VortexResult<Option<Vec<u8>>>

Returns the serialized metadata of the array, or None if the array does not support serialization.

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

Formats a human-readable metadata description.

impl<V: VTable> Debug for ArrayAdapter<V>

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

Formats the value using the given formatter.