Struct ArrayRef 

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

A reference-counted pointer to a type-erased array.

Implementations

impl ArrayRef

pub fn ptr_eq(this: &ArrayRef, other: &ArrayRef) -> bool

Returns true if the two ArrayRefs point to the same allocation.

impl ArrayRef

pub fn len(&self) -> usize

Returns the length of the array.

pub fn is_empty(&self) -> bool

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

pub fn dtype(&self) -> &DType

Returns the logical Vortex DType of the array.

pub fn encoding_id(&self) -> ArrayId

Returns the encoding ID of the array.

pub fn slice(&self, range: Range<usize>) -> VortexResult<ArrayRef>

Performs a constant-time slice of the array.

pub fn filter(&self, mask: Mask) -> VortexResult<ArrayRef>

Wraps the array in a FilterArray such that it is logically filtered by the given mask.

pub fn take(&self, indices: ArrayRef) -> VortexResult<ArrayRef>

Wraps the array in a DictArray such that it is logically taken by the given indices.

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

Fetch the scalar at the given index.

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

Returns whether the item at index is valid.

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

Returns whether the item at index is invalid.

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

Returns whether all items in the array are valid.

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

Returns whether the array is all invalid.

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

Returns the number of valid elements in the array.

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

Returns the number of invalid elements in the array.

pub fn validity(&self) -> VortexResult<Validity>

Returns the Validity of the array.

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

Returns the canonical validity mask for the array.

pub fn into_canonical(self) -> VortexResult<Canonical>

Returns the canonical representation of the array.

pub fn to_canonical(&self) -> VortexResult<Canonical>

Returns the canonical representation of the array.

pub fn append_to_builder( &self, builder: &mut dyn ArrayBuilder, ctx: &mut ExecutionCtx, ) -> VortexResult<()>

Writes the array into the canonical builder.

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

Returns the statistics of the array.

pub fn is<M: Matcher>(&self) -> bool

Does the array match the given matcher.

pub fn as_<M: Matcher>(&self) -> M::Match<'_>

Returns the array downcast by the given matcher.

pub fn as_opt<M: Matcher>(&self) -> Option<M::Match<'_>>

Returns the array downcast by the given matcher.

pub fn try_downcast<V: VTable>(self) -> Result<Array<V>, ArrayRef>

Returns the array downcast to the given Array<V> as an owned typed handle.

pub fn downcast<V: VTable>(self) -> Array<V>

Returns the array downcast to the given Array<V> as an owned typed handle.

Panics

Panics if the array is not of the given type.

pub fn as_typed<V: VTable>(&self) -> Option<ArrayView<'_, V>>

Returns a reference to the typed ArrayInner<V> if this array matches the given vtable type.

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

Returns the constant scalar if this is a constant array.

pub fn nbytes(&self) -> u64

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

pub fn is_arrow(&self) -> bool

Returns whether this array is an arrow encoding.

pub fn is_canonical(&self) -> bool

Whether the array is of a canonical encoding.

pub fn with_slot( self, slot_idx: usize, replacement: ArrayRef, ) -> VortexResult<ArrayRef>

Returns a new array with the slot at slot_idx replaced by replacement.

This is only valid for physical rewrites: the replacement must have the same logical DType and len as the existing slot.

Takes ownership to allow in-place mutation when the refcount is 1.

pub fn with_slots(self, slots: Vec<Option<ArrayRef>>) -> VortexResult<ArrayRef>

Returns a new array with the provided slots.

This is only valid for physical rewrites: slot count, presence, logical DType, and logical len must remain unchanged.

pub fn reduce(&self) -> VortexResult<Option<ArrayRef>>

pub fn reduce_parent( &self, parent: &ArrayRef, child_idx: usize, ) -> VortexResult<Option<ArrayRef>>

pub fn execute_parent( &self, parent: &ArrayRef, child_idx: usize, ctx: &mut ExecutionCtx, ) -> VortexResult<Option<ArrayRef>>

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

Returns the children of the array.

pub fn nchildren(&self) -> usize

Returns the number of children of the array.

pub fn nth_child(&self, idx: usize) -> Option<ArrayRef>

Returns the nth child of the array without allocating a Vec.

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

Returns the names of the children of the array.

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

Returns the array’s children with their names.

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

Returns the data buffers of the array.

pub fn buffer_handles(&self) -> Vec<BufferHandle>

Returns the buffer handles of the array.

pub fn buffer_names(&self) -> Vec<String>

Returns the names of the buffers of the array.

pub fn named_buffers(&self) -> Vec<(String, BufferHandle)>

Returns the array’s buffers with their names.

pub fn nbuffers(&self) -> usize

Returns the number of data buffers of the array.

pub fn slots(&self) -> &[Option<ArrayRef>]

Returns the slots of the array.

pub fn slot_name(&self, idx: usize) -> String

Returns the name of the slot at the given index.

pub fn metadata(&self, session: &VortexSession) -> VortexResult<Option<Vec<u8>>>

Returns the serialized metadata of the array.

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

Formats a human-readable metadata description.

pub fn is_host(&self) -> bool

Returns whether all buffers are host-resident.

pub fn nbuffers_recursive(&self) -> usize

Count the number of buffers encoded by self and all child arrays.

pub fn depth_first_traversal(&self) -> DepthFirstArrayIterator

Depth-first traversal of the array and its children.

impl ArrayRef

pub fn display_values(&self) -> impl Display

Display logical values of the array

For example, an i16 typed array containing the first five non-negative integers is displayed as: [0i16, 1i16, 2i16, 3i16, 4i16].

Examples

let array = buffer![0_i16, 1, 2, 3, 4].into_array();
assert_eq!(
    format!("{}", array.display_values()),
    "[0i16, 1i16, 2i16, 3i16, 4i16]",
)

See also: Array::display_as, DisplayArrayAs, and DisplayOptions.

pub fn display_as(&self, options: DisplayOptions) -> impl Display

Display the array as specified by the options.

See DisplayOptions for examples.

pub fn display_tree_encodings_only(&self) -> TreeDisplay

Display the tree of array encodings and lengths without metadata, buffers, or stats.

Examples

let array = buffer![0_i16, 1, 2, 3, 4].into_array();
let expected = "root: vortex.primitive(i16, len=5)\n";
assert_eq!(format!("{}", array.display_tree_encodings_only()), expected);

let array = StructArray::from_fields(&[
    ("x", buffer![1, 2].into_array()),
    ("y", buffer![3, 4].into_array()),
]).unwrap().into_array();
let expected = "root: vortex.struct({x=i32, y=i32}, len=2)
  x: vortex.primitive(i32, len=2)
  y: vortex.primitive(i32, len=2)
";
assert_eq!(format!("{}", array.display_tree_encodings_only()), expected);

pub fn display_tree(&self) -> TreeDisplay

Display the tree of encodings of this array as an indented lists.

While some metadata (such as length, bytes and validity-rate) are included, the logical values of the array are not displayed. To view the logical values see Array::display_as and DisplayOptions.

Examples

let array = buffer![0_i16, 1, 2, 3, 4].into_array();
let expected = "root: vortex.primitive(i16, len=5) nbytes=10 B (100.00%)
  metadata: ptype: i16
  buffer: values host 10 B (align=2) (100.00%)
";
assert_eq!(format!("{}", array.display_tree()), expected);

pub fn tree_display(&self) -> TreeDisplay

Create a tree display with all built-in extractors (nbytes, stats, metadata, buffers).

This is the default, fully-detailed tree display. Use tree_display_builder() for a blank slate.

Examples

let array = buffer![0_i16, 1, 2, 3, 4].into_array();
let expected = "root: vortex.primitive(i16, len=5) nbytes=10 B (100.00%)
  metadata: ptype: i16
  buffer: values host 10 B (align=2) (100.00%)
";
assert_eq!(array.tree_display().to_string(), expected);

pub fn tree_display_builder(&self) -> TreeDisplay

Create a composable tree display builder with no extractors.

With no extractors, only the node names are shown. Add extractors with .with() to include additional information. Most builders should start with EncodingSummaryExtractor to include encoding headers.

Examples

use vortex_array::display::{EncodingSummaryExtractor, NbytesExtractor, MetadataExtractor, BufferExtractor};

let array = buffer![0_i16, 1, 2, 3, 4].into_array();

// Encodings only
let encodings = array.tree_display_builder()
    .with(EncodingSummaryExtractor)
    .to_string();
assert_eq!(encodings, "root: vortex.primitive(i16, len=5)\n");

// With encoding + nbytes
let with_nbytes = array.tree_display_builder()
    .with(EncodingSummaryExtractor)
    .with(NbytesExtractor)
    .to_string();
assert_eq!(with_nbytes, "root: vortex.primitive(i16, len=5) nbytes=10 B (100.00%)\n");

// With encoding, metadata, and buffers
let detailed = array.tree_display_builder()
    .with(EncodingSummaryExtractor)
    .with(MetadataExtractor)
    .with(BufferExtractor { show_percent: false })
    .to_string();
let expected = "root: vortex.primitive(i16, len=5)\n  metadata: ptype: i16\n  buffer: values host 10 B (align=2)\n";
assert_eq!(detailed, expected);

pub fn display_table(&self) -> impl Display

Display the array as a formatted table.

For struct arrays, displays a column for each field in the struct. For regular arrays, displays a single column with values.

Examples

let s = StructArray::from_fields(&[
    ("x", buffer![1, 2].into_array()),
    ("y", buffer![3, 4].into_array()),
]).unwrap().into_array();
let expected = "
┌──────┬──────┐
│  x   │  y   │
├──────┼──────┤
│ 1i32 │ 3i32 │
├──────┼──────┤
│ 2i32 │ 4i32 │
└──────┴──────┘".trim();
assert_eq!(format!("{}", s.display_table()), expected);

impl ArrayRef

pub fn execute<E: Executable>(self, ctx: &mut ExecutionCtx) -> VortexResult<E>

Execute this array to produce an instance of E.

See the Executable implementation for details on how this execution is performed.

pub fn execute_as<E: Executable>( self, _name: &'static str, ctx: &mut ExecutionCtx, ) -> VortexResult<E>

Execute this array, labeling the execution step with a name for tracing.

pub fn execute_until<M: Matcher>( self, ctx: &mut ExecutionCtx, ) -> VortexResult<ArrayRef>

Iteratively execute this array until the Matcher matches, using an explicit work stack.

The scheduler repeatedly:

1. Checks if the current array matches M — if so, pops the stack or returns.
2. Runs execute_parent on each child for child-driven optimizations.
3. Calls execute which returns an ExecutionStep.

Note: the returned array may not match M. If execution converges to a canonical form that does not match M, the canonical array is returned since no further execution progress is possible.

For safety, we will error when the number of execution iterations reaches a configurable maximum (default 128, override with VORTEX_MAX_ITERATIONS).

impl ArrayRef

pub fn apply(self, expr: &Expression) -> VortexResult<ArrayRef>

Apply the expression to this array, producing a new array in constant time.

impl ArrayRef

pub fn to_array_iterator(&self) -> impl ArrayIterator + 'static

Create an ArrayIterator over the array.

impl ArrayRef

pub fn normalize( self, options: &mut NormalizeOptions<'_>, ) -> VortexResult<ArrayRef>

Normalize the array according to given options.

This operation performs a recursive traversal of the array. Any non-allowed encoding is normalized per the configured operation.

impl ArrayRef

pub fn serialize( &self, ctx: &ArrayContext, session: &VortexSession, options: &SerializeOptions, ) -> VortexResult<Vec<ByteBuffer>>

Serialize the array into a sequence of byte buffers that should be written contiguously. This function returns a vec to avoid copying data buffers.

Optionally, padding can be included to guarantee buffer alignment and ensure zero-copy reads within the context of an external file or stream. In this case, the alignment of the first byte buffer should be respected when writing the buffers to the stream or file.

The format of this blob is a sequence of data buffers, possible with prefixed padding, followed by a flatbuffer containing an fba::Array message, and ending with a little-endian u32 describing the length of the flatbuffer message.

impl ArrayRef

pub fn to_array_stream(&self) -> impl ArrayStream + 'static

Create an ArrayStream over the array.

impl ArrayRef

pub fn as_null_typed(&self) -> NullTyped<'_>

Downcasts the array for null-specific behavior.

pub fn as_bool_typed(&self) -> BoolTyped<'_>

Downcasts the array for bool-specific behavior.

pub fn as_primitive_typed(&self) -> PrimitiveTyped<'_>

Downcasts the array for primitive-specific behavior.

pub fn as_decimal_typed(&self) -> DecimalTyped<'_>

Downcasts the array for decimal-specific behavior.

pub fn as_utf8_typed(&self) -> Utf8Typed<'_>

Downcasts the array for utf8-specific behavior.

pub fn as_binary_typed(&self) -> BinaryTyped<'_>

Downcasts the array for binary-specific behavior.

pub fn as_struct_typed(&self) -> StructTyped<'_>

Downcasts the array for struct-specific behavior.

pub fn as_list_typed(&self) -> ListTyped<'_>

Downcasts the array for list-specific behavior.

pub fn as_extension_typed(&self) -> ExtensionTyped<'_>

Downcasts the array for extension-specific behavior.

pub fn try_to_mask_fill_null_false( &self, ctx: &mut ExecutionCtx, ) -> VortexResult<Mask>

Trait Implementations

impl ArrayBuiltins for ArrayRef

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

Cast to the given data type.

fn fill_null(&self, fill_value: impl Into<Scalar>) -> VortexResult<ArrayRef>

Replace null values with the given fill value.

fn get_item(&self, field_name: impl Into<FieldName>) -> VortexResult<ArrayRef>

Get item by field name (for struct types).

fn is_null(&self) -> VortexResult<ArrayRef>

Is null check.

fn mask(self, mask: ArrayRef) -> VortexResult<ArrayRef>

Mask the array using the given boolean mask. The resulting array’s validity is the intersection of the original array’s validity and the mask’s validity.

fn not(&self) -> VortexResult<ArrayRef>

Boolean negation.

fn zip(&self, if_true: ArrayRef, if_false: ArrayRef) -> VortexResult<ArrayRef>

Conditional selection: result[i] = if mask[i] then if_true[i] else if_false[i].

fn list_contains(&self, value: ArrayRef) -> VortexResult<ArrayRef>

Check if a list contains a value.

fn binary(&self, rhs: ArrayRef, op: Operator) -> VortexResult<ArrayRef>

Apply a binary operator to this array and another.

fn between( self, lower: ArrayRef, upper: ArrayRef, options: BetweenOptions, ) -> VortexResult<ArrayRef>

Compare a values between lower </<= value </<= upper

impl ArrayEq for ArrayRef

fn array_eq(&self, other: &Self, precision: Precision) -> bool

impl ArrayHash for ArrayRef

fn array_hash<H: Hasher>(&self, state: &mut H, precision: Precision)

impl ArrayOptimizer for ArrayRef

fn optimize(&self) -> VortexResult<ArrayRef>

Optimize the root array node only by running reduce and reduce_parent rules to fixpoint.

fn optimize_recursive(&self) -> VortexResult<ArrayRef>

Optimize the entire array tree recursively (root and all descendants).

impl ArrowArrayExecutor for ArrayRef

fn execute_arrow( self, data_type: Option<&DataType>, ctx: &mut ExecutionCtx, ) -> VortexResult<ArrowArrayRef>

Execute the array to produce an Arrow array.

fn execute_record_batches( self, schema: &Schema, ctx: &mut ExecutionCtx, ) -> VortexResult<Vec<RecordBatch>>

Execute the array to produce Arrow RecordBatch’s with the given schema.

fn execute_record_batch( self, schema: &Schema, ctx: &mut ExecutionCtx, ) -> VortexResult<RecordBatch>

Execute the array to produce an Arrow RecordBatch with the given schema.

impl<V: VTable> AsRef<ArrayRef> for Array<V>

fn as_ref(&self) -> &ArrayRef

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

impl<V: VTable> AsRef<ArrayRef> for ArrayView<'_, V>

fn as_ref(&self) -> &ArrayRef

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

impl Clone for ArrayRef

fn clone(&self) -> ArrayRef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ArrayRef

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

Formats the value using the given formatter.

impl Display for ArrayRef

Display the encoding and limited metadata of this array.

Examples

let array = buffer![0_i16, 1, 2, 3, 4].into_array();
assert_eq!(
    format!("{}", array),
    "vortex.primitive(i16, len=5)",
);

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

Formats the value using the given formatter.

impl Executable for ArrayRef

Executing an ArrayRef into an ArrayRef is the atomic execution loop within Vortex.

It attempts to take the smallest possible step of execution such that the returned array is incrementally more “executed” than the input array. In other words, it is closer to becoming a canonical array.

The execution steps are as follows: 0. Check for canonical.

1. Attempt to reduce the array with metadata-only optimizations.
2. Attempt to call reduce_parent on each child.
3. Attempt to call execute_parent on each child.
4. Call execute on the array itself (which returns an ExecutionStep).

Most users will not call this method directly, instead preferring to specify an executable target such as crate::Columnar, Canonical, or any of the canonical array types (such as crate::arrays::PrimitiveArray).

fn execute(array: ArrayRef, ctx: &mut ExecutionCtx) -> VortexResult<Self>

impl<V: VTable> From<Array<V>> for ArrayRef

fn from(value: Array<V>) -> ArrayRef

Converts to this type from the input type.

impl From<Canonical> for ArrayRef

fn from(value: Canonical) -> Self

Converts to this type from the input type.

impl From<TemporalData> for ArrayRef

fn from(value: TemporalData) -> Self

Converts to this type from the input type.

impl FromArrowArray<&BooleanArray> for ArrayRef

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

impl FromArrowArray<&FixedSizeListArray> for ArrayRef

fn from_arrow( array: &ArrowFixedSizeListArray, nullable: bool, ) -> VortexResult<Self>

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

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

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

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

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

impl<O: IntegerPType + OffsetSizeTrait> FromArrowArray<&GenericListArray<O>> for ArrayRef

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

impl<O: OffsetSizeTrait + NativePType> FromArrowArray<&GenericListViewArray<O>> for ArrayRef

fn from_arrow( array: &GenericListViewArray<O>, nullable: bool, ) -> VortexResult<Self>

impl FromArrowArray<&NullArray> for ArrayRef

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

impl FromArrowArray<&PrimitiveArray<Date32Type>> for ArrayRef

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

impl FromArrowArray<&PrimitiveArray<Date64Type>> for ArrayRef

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

impl FromArrowArray<&PrimitiveArray<Decimal128Type>> for ArrayRef

fn from_arrow( array: &ArrowPrimitiveArray<Decimal128Type>, nullable: bool, ) -> VortexResult<Self>

impl FromArrowArray<&PrimitiveArray<Decimal256Type>> for ArrayRef

fn from_arrow( array: &ArrowPrimitiveArray<Decimal256Type>, nullable: bool, ) -> VortexResult<Self>

impl FromArrowArray<&PrimitiveArray<Decimal32Type>> for ArrayRef

fn from_arrow( array: &ArrowPrimitiveArray<Decimal32Type>, nullable: bool, ) -> VortexResult<Self>

impl FromArrowArray<&PrimitiveArray<Decimal64Type>> for ArrayRef

fn from_arrow( array: &ArrowPrimitiveArray<Decimal64Type>, nullable: bool, ) -> VortexResult<Self>

impl FromArrowArray<&PrimitiveArray<Float16Type>> for ArrayRef

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

impl FromArrowArray<&PrimitiveArray<Float32Type>> for ArrayRef

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

impl FromArrowArray<&PrimitiveArray<Float64Type>> for ArrayRef

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

impl FromArrowArray<&PrimitiveArray<Int16Type>> for ArrayRef

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

impl FromArrowArray<&PrimitiveArray<Int32Type>> for ArrayRef

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

impl FromArrowArray<&PrimitiveArray<Int64Type>> for ArrayRef

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

impl FromArrowArray<&PrimitiveArray<Int8Type>> for ArrayRef

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

impl FromArrowArray<&PrimitiveArray<Time32MillisecondType>> for ArrayRef

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

impl FromArrowArray<&PrimitiveArray<Time32SecondType>> for ArrayRef

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

impl FromArrowArray<&PrimitiveArray<Time64MicrosecondType>> for ArrayRef

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

impl FromArrowArray<&PrimitiveArray<Time64NanosecondType>> for ArrayRef

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

impl FromArrowArray<&PrimitiveArray<TimestampMicrosecondType>> for ArrayRef

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

impl FromArrowArray<&PrimitiveArray<TimestampMillisecondType>> for ArrayRef

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

impl FromArrowArray<&PrimitiveArray<TimestampNanosecondType>> for ArrayRef

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

impl FromArrowArray<&PrimitiveArray<TimestampSecondType>> for ArrayRef

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

impl FromArrowArray<&PrimitiveArray<UInt16Type>> for ArrayRef

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

impl FromArrowArray<&PrimitiveArray<UInt32Type>> for ArrayRef

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

impl FromArrowArray<&PrimitiveArray<UInt64Type>> for ArrayRef

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

impl FromArrowArray<&PrimitiveArray<UInt8Type>> for ArrayRef

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

impl FromArrowArray<&RecordBatch> for ArrayRef

fn from_arrow(array: &RecordBatch, nullable: bool) -> VortexResult<Self>

impl FromArrowArray<&StructArray> for ArrayRef

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

impl FromArrowArray<&dyn Array> for ArrayRef

fn from_arrow(array: &dyn ArrowArray, nullable: bool) -> VortexResult<Self>

impl FromArrowArray<RecordBatch> for ArrayRef

fn from_arrow(array: RecordBatch, nullable: bool) -> VortexResult<Self>

impl FromIterator<ArrayRef> for Array<Chunked>

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

Creates a value from an iterator.

impl IndexOrd<Scalar> for ArrayRef

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

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

fn index_len(&self) -> usize

Get the length of the underlying ordered collection

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

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

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

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

impl IntoArray for ArrayRef

fn into_array(self) -> ArrayRef

impl IntoArrowArray for ArrayRef

fn into_arrow_preferred(self) -> VortexResult<ArrowArrayRef>

Convert this crate::ArrayRef into an Arrow crate::ArrayRef by using the array’s preferred (cheapest) Arrow DataType.

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

impl ReduceNode for ArrayRef

fn as_any(&self) -> &dyn Any

Downcast to Any.

fn node_dtype(&self) -> VortexResult<DType>

Return the data type of this node.

fn scalar_fn(&self) -> Option<&ScalarFnRef>

Return this node’s scalar function if it is indeed a scalar fn.

fn child(&self, idx: usize) -> ReduceNodeRef

Descend to the child of this handle.

fn child_count(&self) -> usize

Returns the number of children of this node.

impl ToCanonical for ArrayRef

fn to_null(&self) -> NullArray

Canonicalize into a NullArray if the target is Null typed.

fn to_bool(&self) -> BoolArray

Canonicalize into a BoolArray if the target is Bool typed.

fn to_primitive(&self) -> PrimitiveArray

Canonicalize into a PrimitiveArray if the target is Primitive typed.

fn to_decimal(&self) -> DecimalArray

Canonicalize into a DecimalArray if the target is Decimal typed.

fn to_struct(&self) -> StructArray

Canonicalize into a StructArray if the target is Struct typed.

fn to_listview(&self) -> ListViewArray

Canonicalize into a ListViewArray if the target is List typed.

fn to_fixed_size_list(&self) -> FixedSizeListArray

Canonicalize into a FixedSizeListArray if the target is List typed.

fn to_varbinview(&self) -> VarBinViewArray

Canonicalize into a VarBinViewArray if the target is Utf8 or Binary typed.

fn to_extension(&self) -> ExtensionArray

Canonicalize into an ExtensionArray if the array is Extension typed.

impl TryFrom<&ArrayRef> for RecordBatch

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(value: &ArrayRef) -> VortexResult<Self>

Performs the conversion.

impl TryFrom<ArrayRef> for TemporalData

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

Try to specialize a generic Vortex array as a TemporalData.

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.