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 as_primitive(&self) -> PrimitiveArray

impl Array

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

impl Array

pub fn encoding(&self) -> EncodingRef

pub fn len(&self) -> usize

Returns the number of logical elements in the array.

pub fn is_empty(&self) -> bool

pub fn nbytes(&self) -> usize

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

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 of 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(&self) -> VortexResult<Cow<'_, [u8]>>

Get back the (possibly owned) metadata for the array.

View arrays will return a reference to their bytes, while heap-backed arrays must first serialize their metadata, returning an owned byte array to the caller.

pub fn buffer(&self) -> Option<&Buffer>

pub fn into_buffer(self) -> Option<Buffer>

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 with_dyn<R, F>(&self, f: F) -> R

where F: FnMut(&dyn ArrayTrait) -> R,

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 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 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 SparseArray

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 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 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 From<Array> for ArrayData

fn from(value: Array) -> ArrayData

Converts to this type from the input type.

impl From<ArrayData> for Array

fn from(value: ArrayData) -> Array

Converts to this type from the input type.

impl From<BoolArray> for Array

fn from(value: BoolArray) -> Array

Converts to this type from the input type.

impl From<Buffer> for Array

fn from(value: Buffer) -> 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 From<ChunkedArray> for Array

fn from(value: ChunkedArray) -> Array

Converts to this type from the input type.

impl From<ConstantArray> for Array

fn from(value: ConstantArray) -> Array

Converts to this type from the input type.

impl From<ExtensionArray> for Array

fn from(value: ExtensionArray) -> Array

Converts to this type from the input type.

impl From<NullArray> for Array

fn from(value: NullArray) -> Array

Converts to this type from the input type.

impl From<NullBuffer> for Array

fn from(value: NullBuffer) -> 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 From<PrimitiveArray> for Array

fn from(value: PrimitiveArray) -> Array

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<SparseArray> for Array

fn from(value: SparseArray) -> Array

Converts to this type from the input type.

impl From<StructArray> for Array

fn from(value: StructArray) -> Array

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 From<VarBinArray> for Array

fn from(value: VarBinArray) -> Array

Converts to this type from the input type.

impl From<VarBinViewArray> for Array

fn from(value: VarBinViewArray) -> Array

Converts to this type from the input type.

impl From<Vec<Option<Buffer>>> for Array

fn from(value: Vec<Option<Buffer>>) -> Self

Converts to this type from the input type.

impl From<Vec<Option<BufferString>>> for Array

fn from(value: Vec<Option<BufferString>>) -> Self

Converts to this type from the input type.

impl From<Vec<Option<bool>>> for Array

fn from(value: Vec<Option<bool>>) -> Self

Converts to this type from the input type.

impl From<Vec<Option<f16>>> for Array

fn from(value: Vec<Option<f16>>) -> Self

Converts to this type from the input type.

impl From<Vec<Option<f32>>> for Array

fn from(value: Vec<Option<f32>>) -> Self

Converts to this type from the input type.

impl From<Vec<Option<f64>>> for Array

fn from(value: Vec<Option<f64>>) -> Self

Converts to this type from the input type.

impl From<Vec<Option<i16>>> for Array

fn from(value: Vec<Option<i16>>) -> Self

Converts to this type from the input type.

impl From<Vec<Option<i32>>> for Array

fn from(value: Vec<Option<i32>>) -> Self

Converts to this type from the input type.

impl From<Vec<Option<i64>>> for Array

fn from(value: Vec<Option<i64>>) -> Self

Converts to this type from the input type.

impl From<Vec<Option<i8>>> for Array

fn from(value: Vec<Option<i8>>) -> Self

Converts to this type from the input type.

impl From<Vec<Option<u16>>> for Array

fn from(value: Vec<Option<u16>>) -> Self

Converts to this type from the input type.

impl From<Vec<Option<u32>>> for Array

fn from(value: Vec<Option<u32>>) -> Self

Converts to this type from the input type.

impl From<Vec<Option<u64>>> for Array

fn from(value: Vec<Option<u64>>) -> Self

Converts to this type from the input type.

impl From<Vec<Option<u8>>> for Array

fn from(value: Vec<Option<u8>>) -> Self

Converts to this type from the input type.

impl From<Vec<f16>> for Array

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

Converts to this type from the input type.

impl From<Vec<f32>> for Array

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

Converts to this type from the input type.

impl From<Vec<f64>> for Array

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

Converts to this type from the input type.

impl From<Vec<i16>> for Array

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

Converts to this type from the input type.

impl From<Vec<i32>> for Array

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

Converts to this type from the input type.

impl From<Vec<i64>> for Array

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

Converts to this type from the input type.

impl From<Vec<i8>> for Array

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

Converts to this type from the input type.

impl From<Vec<u16>> for Array

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

Converts to this type from the input type.

impl From<Vec<u32>> for Array

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

Converts to this type from the input type.

impl From<Vec<u64>> for Array

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

Converts to this type from the input type.

impl From<Vec<u8>> for Array

fn from(value: Vec<u8>) -> 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 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 IndexOrd<Scalar> for Array

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

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 IntoCanonical for Array

IntoCanonical implementation for Array.

Canonicalizing an array requires potentially decompressing, so this requires a roundtrip through the array’s internal codec.

fn into_canonical(self) -> VortexResult<Canonical>

impl Len for Array

fn len(&self) -> usize

impl ToArrayData for Array

fn to_array_data(&self) -> ArrayData

impl TryFrom<&Array> for BoolArray

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 ChunkedArray

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 ConstantArray

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 ExtensionArray

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(array: &Array) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&Array> for PrimitiveArray

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 SparseArray

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 StructArray

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 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<'a, D: ArrayDef> TryFrom<&'a Array> for TypedArray<D>

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&Array> for VarBinArray

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 VarBinViewArray

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 BoolArray

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 ChunkedArray

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 ConstantArray

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 ExtensionArray

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 LogicalValidity

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Array> for NullArray

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 PrimitiveArray

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 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 SparseArray

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 StructArray

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 TemporalArray

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

Try to specialize a generic Vortex array as a TemporalArray.

Delegates to TryFrom<&Array>.

type Error = VortexError

The type returned in the event of a conversion error.

impl<D: ArrayDef> TryFrom<Array> for TypedArray<D>

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 Validity

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Array> for VarBinArray

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 VarBinViewArray

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<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.