Struct Array

pub struct Array(/* private fields */);

A central type for all Vortex arrays, which are known length sequences of typed and possibly compressed data.

This is the main entrypoint for working with in-memory Vortex data, and dispatches work over the underlying encoding or memory representations.

Implementations

impl Array

pub fn try_new_owned( encoding: VTableRef, dtype: DType, len: usize, metadata: Option<ByteBuffer>, buffers: Option<Box<[ByteBuffer]>>, children: Option<Box<[Array]>>, statistics: StatsSet, ) -> VortexResult<Self>

pub fn try_new_viewed<F>( ctx: ContextRef, dtype: DType, len: usize, flatbuffer: FlatBuffer, flatbuffer_init: F, buffers: Vec<ByteBuffer>, ) -> VortexResult<Self>

where F: FnOnce(&[u8]) -> VortexResult<Array<'_>>,

pub fn vtable(&self) -> &VTableRef

Return the array’s encoding VTable.

pub fn encoding(&self) -> EncodingId

Return the array’s encoding ID.

pub fn len(&self) -> usize

Returns the number of logical elements in the array.

pub fn is_empty(&self) -> bool

Check whether the array has any data

pub fn dtype(&self) -> &DType

Return the array’s dtype

pub fn is_canonical(&self) -> bool

Whether the array is of a canonical encoding.

pub fn is_arrow(&self) -> bool

Whether the array is fully zero-copy to Arrow (including children). This means any nested types, like Structs, Lists, and Extensions are not present.

pub fn is_constant(&self) -> bool

Return whether the array is constant.

pub fn as_constant(&self) -> Option<Scalar>

Return scalar value of this array if the array is constant

pub fn child<'a>( &'a self, idx: usize, dtype: &'a DType, len: usize, ) -> VortexResult<Self>

pub fn children(&self) -> Vec<Array>

Returns a Vec of Arrays with all the array’s child arrays.

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

Returns a Vec of Arrays with all the array’s child arrays.

pub fn nchildren(&self) -> usize

Returns the number of child arrays

pub fn depth_first_traversal(&self) -> ArrayChildrenIterator

pub fn cumulative_nbuffers(&self) -> usize

Count the number of cumulative buffers encoded by self.

pub fn all_buffer_offsets(&self, alignment: usize) -> Vec<u64>

Return the buffer offsets and the total length of all buffers, assuming the given alignment. This includes all child buffers.

pub fn metadata_bytes(&self) -> Option<&[u8]>

pub fn nbuffers(&self) -> usize

pub fn byte_buffer(&self, index: usize) -> Option<&ByteBuffer>

pub fn byte_buffers(&self) -> impl Iterator<Item = ByteBuffer> + '_

pub fn into_byte_buffer(self, index: usize) -> Option<ByteBuffer>

pub fn into_array_iterator(self) -> impl ArrayIterator

pub fn into_array_stream(self) -> impl ArrayStream

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

Checks whether array is of a given encoding.

pub fn try_downcast_ref<E: Encoding>(&self) -> VortexResult<(&E::Array, &E)>

where for<'a> &'a E::Array: TryFrom<&'a Array, Error = VortexError>,

impl Array

pub fn nbytes(&self) -> usize

Total size of the array in bytes, including all children and buffers.

impl Array

pub fn statistics(&self) -> &(dyn Statistics + '_)

pub fn inherit_statistics(&self, parent: &dyn Statistics)

impl Array

pub fn tree_display(&self) -> TreeDisplayWrapper<'_>

impl Array

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

Return whether the element at the given index is valid (true) or null (false).

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

Return whether all elements in the array are valid.

pub fn null_count(&self) -> VortexResult<usize>

Return the number of null elements in the array.

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

Return the canonical validity of the array as a Mask.

impl Array

Provide functions on type-erased Array to downcast into dtype-specific array variants.

pub fn as_null_array(&self) -> Option<&dyn NullArrayTrait>

pub fn as_bool_array(&self) -> Option<&dyn BoolArrayTrait>

pub fn as_primitive_array(&self) -> Option<&dyn PrimitiveArrayTrait>

pub fn as_utf8_array(&self) -> Option<&dyn Utf8ArrayTrait>

pub fn as_binary_array(&self) -> Option<&dyn BinaryArrayTrait>

pub fn as_struct_array(&self) -> Option<&dyn StructArrayTrait>

pub fn as_list_array(&self) -> Option<&dyn ListArrayTrait>

pub fn as_extension_array(&self) -> Option<&dyn ExtensionArrayTrait>

Trait Implementations

impl AsRef<Array> for Array

fn as_ref(&self) -> &Array

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<Array> for BoolArray

fn as_ref(&self) -> &Array

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<Array> for Canonical

fn as_ref(&self) -> &Array

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<Array> for ChunkedArray

fn as_ref(&self) -> &Array

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<Array> for ConstantArray

fn as_ref(&self) -> &Array

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<Array> for ExtensionArray

fn as_ref(&self) -> &Array

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<Array> for ListArray

fn as_ref(&self) -> &Array

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<Array> for NullArray

fn as_ref(&self) -> &Array

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<Array> for PrimitiveArray

fn as_ref(&self) -> &Array

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<Array> for StructArray

fn as_ref(&self) -> &Array

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<Array> for VarBinArray

fn as_ref(&self) -> &Array

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<Array> for VarBinViewArray

fn as_ref(&self) -> &Array

Converts this type into a shared reference of the (usually inferred) input type.

impl<E> BinaryBooleanFn<Array> for E

where E: BinaryBooleanFn<E::Array> + Encoding, for<'a> &'a E::Array: TryFrom<&'a Array, Error = VortexError>,

fn binary_boolean( &self, lhs: &Array, rhs: &Array, op: BinaryOperator, ) -> VortexResult<Option<Array>>

impl<E> BinaryNumericFn<Array> for E

where E: BinaryNumericFn<E::Array> + Encoding, for<'a> &'a E::Array: TryFrom<&'a Array, Error = VortexError>,

fn binary_numeric( &self, lhs: &Array, rhs: &Array, op: BinaryNumericOperator, ) -> VortexResult<Option<Array>>

impl<E> CanonicalVTable<Array> for E

where E: CanonicalVTable<E::Array> + Encoding, E::Array: TryFrom<Array, Error = VortexError>,

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

impl CanonicalVTable<Array> for OpaqueEncoding

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

impl<E> CastFn<Array> for E

where E: CastFn<E::Array> + Encoding, for<'a> &'a E::Array: TryFrom<&'a Array, Error = VortexError>,

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

impl Clone for Array

fn clone(&self) -> Array

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<E> CompareFn<Array> for E

where E: CompareFn<E::Array> + Encoding, for<'a> &'a E::Array: TryFrom<&'a Array, Error = VortexError>,

fn compare( &self, lhs: &Array, rhs: &Array, operator: Operator, ) -> VortexResult<Option<Array>>

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 Array

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

Formats the value using the given formatter.

impl Display for Array

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

Formats the value using the given formatter.

impl<E> FillForwardFn<Array> for E

where E: FillForwardFn<E::Array> + Encoding, for<'a> &'a E::Array: TryFrom<&'a Array, Error = VortexError>,

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

impl<E> FillNullFn<Array> for E

where E: FillNullFn<E::Array> + Encoding, for<'a> &'a E::Array: TryFrom<&'a Array, Error = VortexError>,

fn fill_null(&self, array: &Array, fill_value: Scalar) -> VortexResult<Array>

impl<E> FilterFn<Array> for E

where E: FilterFn<E::Array> + Encoding, for<'a> &'a E::Array: TryFrom<&'a Array, Error = VortexError>,

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

Filter an array by the provided predicate.

impl From<Array> for ArrayParts

Convert an Array into ArrayParts.

fn from(array: Array) -> Self

Converts to this type from the input type.

impl From<BooleanBuffer> for Array

fn from(value: BooleanBuffer) -> Self

Converts to this type from the input type.

impl From<Buffer<f16>> for Array

fn from(value: Buffer<f16>) -> Self

Converts to this type from the input type.

impl From<Buffer<f32>> for Array

fn from(value: Buffer<f32>) -> Self

Converts to this type from the input type.

impl From<Buffer<f64>> for Array

fn from(value: Buffer<f64>) -> Self

Converts to this type from the input type.

impl From<Buffer<i16>> for Array

fn from(value: Buffer<i16>) -> Self

Converts to this type from the input type.

impl From<Buffer<i32>> for Array

fn from(value: Buffer<i32>) -> Self

Converts to this type from the input type.

impl From<Buffer<i64>> for Array

fn from(value: Buffer<i64>) -> Self

Converts to this type from the input type.

impl From<Buffer<i8>> for Array

fn from(value: Buffer<i8>) -> Self

Converts to this type from the input type.

impl From<Buffer<u16>> for Array

fn from(value: Buffer<u16>) -> Self

Converts to this type from the input type.

impl From<Buffer<u32>> for Array

fn from(value: Buffer<u32>) -> Self

Converts to this type from the input type.

impl From<Buffer<u64>> for Array

fn from(value: Buffer<u64>) -> Self

Converts to this type from the input type.

impl From<Buffer<u8>> for Array

fn from(value: Buffer<u8>) -> Self

Converts to this type from the input type.

impl From<Buffer> for Array

fn from(value: ArrowBuffer) -> Self

Converts to this type from the input type.

impl From<BufferMut<f16>> for Array

fn from(value: BufferMut<f16>) -> Self

Converts to this type from the input type.

impl From<BufferMut<f32>> for Array

fn from(value: BufferMut<f32>) -> Self

Converts to this type from the input type.

impl From<BufferMut<f64>> for Array

fn from(value: BufferMut<f64>) -> Self

Converts to this type from the input type.

impl From<BufferMut<i16>> for Array

fn from(value: BufferMut<i16>) -> Self

Converts to this type from the input type.

impl From<BufferMut<i32>> for Array

fn from(value: BufferMut<i32>) -> Self

Converts to this type from the input type.

impl From<BufferMut<i64>> for Array

fn from(value: BufferMut<i64>) -> Self

Converts to this type from the input type.

impl From<BufferMut<i8>> for Array

fn from(value: BufferMut<i8>) -> Self

Converts to this type from the input type.

impl From<BufferMut<u16>> for Array

fn from(value: BufferMut<u16>) -> Self

Converts to this type from the input type.

impl From<BufferMut<u32>> for Array

fn from(value: BufferMut<u32>) -> Self

Converts to this type from the input type.

impl From<BufferMut<u64>> for Array

fn from(value: BufferMut<u64>) -> Self

Converts to this type from the input type.

impl From<BufferMut<u8>> for Array

fn from(value: BufferMut<u8>) -> Self

Converts to this type from the input type.

impl From<Canonical> for Array

This conversion is always “free” and should not touch underlying data. All it does is create an owned pointer to the underlying concrete array type.

This combined with the above IntoCanonical impl for Array allows simple two-way conversions between arbitrary Vortex encodings and canonical Arrow-compatible encodings.

fn from(value: Canonical) -> Self

Converts to this type from the input type.

impl<O> From<OffsetBuffer<O>> for Array

where O: NativePType + OffsetSizeTrait,

fn from(value: OffsetBuffer<O>) -> Self

Converts to this type from the input type.

impl<T> From<ScalarBuffer<T>> for Array

where T: ArrowNativeType + NativePType,

fn from(value: ScalarBuffer<T>) -> Self

Converts to this type from the input type.

impl From<TemporalArray> for Array

fn from(value: TemporalArray) -> Self

Converts to this type from the input type.

impl FromArrowArray<&BooleanArray> for Array

fn from_arrow(value: &ArrowBooleanArray, nullable: bool) -> Self

impl<T: ByteArrayType> FromArrowArray<&GenericByteArray<T>> for Array

where <T as ByteArrayType>::Offset: NativePType,

fn from_arrow(value: &GenericByteArray<T>, nullable: bool) -> Self

impl<T: ByteViewType> FromArrowArray<&GenericByteViewArray<T>> for Array

fn from_arrow(value: &GenericByteViewArray<T>, nullable: bool) -> Self

impl<O: OffsetSizeTrait + NativePType> FromArrowArray<&GenericListArray<O>> for Array

fn from_arrow(value: &GenericListArray<O>, nullable: bool) -> Self

impl FromArrowArray<&NullArray> for Array

fn from_arrow(value: &ArrowNullArray, nullable: bool) -> Self

impl<T: ArrowPrimitiveType> FromArrowArray<&PrimitiveArray<T>> for Array

where <T as ArrowPrimitiveType>::Native: NativePType,

fn from_arrow(value: &ArrowPrimitiveArray<T>, nullable: bool) -> Self

impl FromArrowArray<&StructArray> for Array

fn from_arrow(value: &ArrowStructArray, nullable: bool) -> Self

impl FromArrowArray<Arc<dyn Array>> for Array

fn from_arrow(array: ArrowArrayRef, nullable: bool) -> Self

impl FromIterator<Array> for ChunkedArray

fn from_iter<T: IntoIterator<Item = Array>>(iter: T) -> Self

Creates a value from an iterator.

impl FromIterator<Option<Buffer<u8>>> for Array

fn from_iter<T: IntoIterator<Item = Option<ByteBuffer>>>(iter: T) -> Self

Creates a value from an iterator.

impl FromIterator<Option<BufferString>> for Array

fn from_iter<T: IntoIterator<Item = Option<BufferString>>>(iter: T) -> Self

Creates a value from an iterator.

impl FromIterator<Option<String>> for Array

fn from_iter<T: IntoIterator<Item = Option<String>>>(iter: T) -> Self

Creates a value from an iterator.

impl FromIterator<Option<bool>> for Array

fn from_iter<T: IntoIterator<Item = Option<bool>>>(iter: T) -> Self

Creates a value from an iterator.

impl FromIterator<Option<f16>> for Array

fn from_iter<T: IntoIterator<Item = Option<f16>>>(iter: T) -> Self

Creates a value from an iterator.

impl FromIterator<Option<f32>> for Array

fn from_iter<T: IntoIterator<Item = Option<f32>>>(iter: T) -> Self

Creates a value from an iterator.

impl FromIterator<Option<f64>> for Array

fn from_iter<T: IntoIterator<Item = Option<f64>>>(iter: T) -> Self

Creates a value from an iterator.

impl FromIterator<Option<i16>> for Array

fn from_iter<T: IntoIterator<Item = Option<i16>>>(iter: T) -> Self

Creates a value from an iterator.

impl FromIterator<Option<i32>> for Array

fn from_iter<T: IntoIterator<Item = Option<i32>>>(iter: T) -> Self

Creates a value from an iterator.

impl FromIterator<Option<i64>> for Array

fn from_iter<T: IntoIterator<Item = Option<i64>>>(iter: T) -> Self

Creates a value from an iterator.

impl FromIterator<Option<i8>> for Array

fn from_iter<T: IntoIterator<Item = Option<i8>>>(iter: T) -> Self

Creates a value from an iterator.

impl FromIterator<Option<u16>> for Array

fn from_iter<T: IntoIterator<Item = Option<u16>>>(iter: T) -> Self

Creates a value from an iterator.

impl FromIterator<Option<u32>> for Array

fn from_iter<T: IntoIterator<Item = Option<u32>>>(iter: T) -> Self

Creates a value from an iterator.

impl FromIterator<Option<u64>> for Array

fn from_iter<T: IntoIterator<Item = Option<u64>>>(iter: T) -> Self

Creates a value from an iterator.

impl FromIterator<Option<u8>> for Array

fn from_iter<T: IntoIterator<Item = Option<u8>>>(iter: T) -> Self

Creates a value from an iterator.

impl IndexOrd<Scalar> for Array

fn index_cmp(&self, idx: usize, elem: &Scalar) -> Option<Ordering>

PartialOrd of the value at index idx with elem. For example, if self[idx] > elem, return Some(Greater).

fn index_lt(&self, idx: usize, elem: &V) -> bool

fn index_le(&self, idx: usize, elem: &V) -> bool

fn index_gt(&self, idx: usize, elem: &V) -> bool

fn index_ge(&self, idx: usize, elem: &V) -> bool

impl IntoArrowArray for Array

fn into_arrow_preferred(self) -> VortexResult<ArrayRef>

Convert this Array into an Arrow ArrayRef by using the array’s preferred Arrow DataType.

fn into_arrow(self, data_type: &DataType) -> VortexResult<ArrayRef>

impl IntoCanonical for Array

fn into_canonical(self) -> VortexResult<Canonical>

Canonicalize an Array into one of the Canonical array forms.

Invariants

The DType of the array will be unchanged by canonicalization.

impl<E> InvertFn<Array> for E

where E: InvertFn<E::Array> + Encoding, for<'a> &'a E::Array: TryFrom<&'a Array, Error = VortexError>,

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

Logically invert a boolean array. Converts true -> false, false -> true, null -> null.

impl Len for Array

fn len(&self) -> usize

impl<E> LikeFn<Array> for E

where E: LikeFn<E::Array> + Encoding, E::Array: TryFrom<Array, Error = VortexError>,

fn like( &self, array: Array, pattern: &Array, options: LikeOptions, ) -> VortexResult<Option<Array>>

impl MetadataVTable<Array> for OpaqueEncoding

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

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

impl<E> ScalarAtFn<Array> for E

where E: ScalarAtFn<E::Array> + Encoding, for<'a> &'a E::Array: TryFrom<&'a Array, Error = VortexError>,

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

impl<E> SearchSortedFn<Array> for E

where E: SearchSortedFn<E::Array> + Encoding, for<'a> &'a E::Array: TryFrom<&'a Array, Error = VortexError>,

fn search_sorted( &self, array: &Array, value: &Scalar, side: SearchSortedSide, ) -> VortexResult<SearchResult>

fn search_sorted_many( &self, array: &Array, values: &[Scalar], side: SearchSortedSide, ) -> VortexResult<Vec<SearchResult>>

Bulk search for many values.

impl<E> SearchSortedUsizeFn<Array> for E

where E: SearchSortedUsizeFn<E::Array> + Encoding, for<'a> &'a E::Array: TryFrom<&'a Array, Error = VortexError>,

fn search_sorted_usize( &self, array: &Array, value: usize, side: SearchSortedSide, ) -> VortexResult<SearchResult>

fn search_sorted_usize_many( &self, array: &Array, values: &[usize], side: SearchSortedSide, ) -> VortexResult<Vec<SearchResult>>

impl<E> SliceFn<Array> for E

where E: SliceFn<E::Array> + Encoding, for<'a> &'a E::Array: TryFrom<&'a Array, Error = VortexError>,

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

fn get(&self, stat: Stat) -> Option<Precision<ScalarValue>>

Returns the value of the statistic only if it’s present

fn to_set(&self) -> StatsSet

Get all existing statistics

fn set(&self, stat: Stat, value: Precision<ScalarValue>)

Set the value of the statistic

fn clear(&self, stat: Stat)

Clear the value of the statistic

fn compute(&self, stat: Stat) -> Option<ScalarValue>

Computes the value of the stat if it’s not present and inexact.

fn retain_only(&self, stats: &[Stat])

fn compute_all(&self, stats: &[Stat]) -> VortexResult<StatsSet>

Compute all the requested statistics (if not already present) Returns a StatsSet with the requested stats and any additional available stats

impl<E> StatisticsVTable<Array> for E

where E: StatisticsVTable<E::Array> + Encoding + 'static, for<'a> &'a E::Array: TryFrom<&'a Array, Error = VortexError>,

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

Compute the requested statistic. Can return additional stats.

impl StatisticsVTable<Array> for OpaqueEncoding

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

Compute the requested statistic. Can return additional stats.

impl<E> TakeFn<Array> for E

where E: TakeFn<E::Array> + Encoding, for<'a> &'a E::Array: TryFrom<&'a Array, Error = VortexError>,

fn take(&self, array: &Array, 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<E> ToArrowFn<Array> for E

where E: ToArrowFn<E::Array> + Encoding, for<'a> &'a E::Array: TryFrom<&'a Array, Error = VortexError>,

fn preferred_arrow_data_type( &self, array: &Array, ) -> 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: &Array, data_type: &DataType, ) -> VortexResult<Option<ArrayRef>>

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

impl<'a> TryFrom<&'a Array> for &'a BoolArray

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(data: &'a Array) -> VortexResult<Self>

Performs the conversion.

impl<'a> TryFrom<&'a Array> for &'a ChunkedArray

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(data: &'a Array) -> VortexResult<Self>

Performs the conversion.

impl<'a> TryFrom<&'a Array> for &'a ConstantArray

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(data: &'a Array) -> VortexResult<Self>

Performs the conversion.

impl<'a> TryFrom<&'a Array> for &'a ExtensionArray

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(data: &'a Array) -> VortexResult<Self>

Performs the conversion.

impl<'a> TryFrom<&'a Array> for &'a ListArray

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(data: &'a Array) -> VortexResult<Self>

Performs the conversion.

impl<'a> TryFrom<&'a Array> for &'a NullArray

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(data: &'a Array) -> VortexResult<Self>

Performs the conversion.

impl<'a> TryFrom<&'a Array> for &'a PrimitiveArray

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(data: &'a Array) -> VortexResult<Self>

Performs the conversion.

impl<'a> TryFrom<&'a Array> for &'a StructArray

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(data: &'a Array) -> VortexResult<Self>

Performs the conversion.

impl<'a> TryFrom<&'a Array> for &'a VarBinArray

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(data: &'a Array) -> VortexResult<Self>

Performs the conversion.

impl<'a> TryFrom<&'a Array> for &'a VarBinViewArray

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(data: &'a Array) -> VortexResult<Self>

Performs the conversion.

impl TryFrom<Array> for BoolArray

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(data: Array) -> VortexResult<Self>

Performs the conversion.

impl TryFrom<Array> for ChunkedArray

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(data: Array) -> VortexResult<Self>

Performs the conversion.

impl TryFrom<Array> for ConstantArray

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(data: Array) -> VortexResult<Self>

Performs the conversion.

impl TryFrom<Array> for ExtensionArray

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(data: Array) -> VortexResult<Self>

Performs the conversion.

impl TryFrom<Array> for ListArray

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(data: Array) -> VortexResult<Self>

Performs the conversion.

impl TryFrom<Array> for Mask

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(array: Array) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Array> for NullArray

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(data: Array) -> VortexResult<Self>

Performs the conversion.

impl TryFrom<Array> for PrimitiveArray

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(data: Array) -> VortexResult<Self>

Performs the conversion.

impl TryFrom<Array> for RecordBatch

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(value: Array) -> VortexResult<Self>

Performs the conversion.

impl TryFrom<Array> for StructArray

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(data: Array) -> VortexResult<Self>

Performs the conversion.

impl TryFrom<Array> for TemporalArray

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

Try to specialize a generic Vortex array as a TemporalArray.

Errors

If the provided Array does not have vortex.ext encoding, an error will be returned.

If the provided Array does not have recognized ExtMetadata corresponding to one of the known TemporalMetadata variants, an error is returned.

type Error = VortexError

The type returned in the event of a conversion error.

impl TryFrom<Array> for VarBinArray

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(data: Array) -> VortexResult<Self>

Performs the conversion.

impl TryFrom<Array> for VarBinViewArray

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(data: Array) -> VortexResult<Self>

Performs the conversion.

impl TryFrom<RecordBatch> for Array

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(value: RecordBatch) -> VortexResult<Self>

Performs the conversion.

impl<E> ValidateVTable<Array> for E

where E: ValidateVTable<E::Array> + Encoding, for<'a> &'a E::Array: TryFrom<&'a Array, Error = VortexError>,

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

impl ValidateVTable<Array> for OpaqueEncoding

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

impl<E> ValidityVTable<Array> for E

where E: ValidityVTable<E::Array> + Encoding, for<'a> &'a E::Array: TryFrom<&'a Array, Error = VortexError>,

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 invalid_count(&self, array: &Array) -> VortexResult<usize>

Returns the number of invalid elements in the array.

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

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<E> VariantsVTable<Array> for E

where E: VariantsVTable<E::Array> + Encoding, for<'a> &'a E::Array: TryFrom<&'a Array, Error = VortexError>,

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 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<E> VisitorVTable<Array> for E

where E: VisitorVTable<E::Array> + Encoding, for<'a> &'a E::Array: TryFrom<&'a Array, Error = VortexError>,

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

impl VisitorVTable<Array> for OpaqueEncoding

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