Enum Value 

pub enum Value {
    Scalar(Scalar),
    Array(Arc<Array>),
    ArrayView(Arc<ArrayV>),
    FieldArray(Arc<FieldArray>),
    Table(Arc<Table>),
    TableView(Arc<TableV>),
    SuperArray(Arc<SuperArray>),
    SuperArrayView(Arc<SuperArrayV>),
    SuperTable(Arc<SuperTable>),
    SuperTableView(Arc<SuperTableV>),
    Matrix(Arc<Matrix>),
    Cube(Arc<Cube>),
    VecValue(Arc<Vec<Value>>),
    BoxValue(Box<Value>),
    ArcValue(Arc<Value>),
    Tuple2(Arc<(Value, Value)>),
    Tuple3(Arc<(Value, Value, Value)>),
    Tuple4(Arc<(Value, Value, Value, Value)>),
    Tuple5(Arc<(Value, Value, Value, Value, Value)>),
    Tuple6(Arc<(Value, Value, Value, Value, Value, Value)>),
    Custom(Arc<dyn CustomValue>),
}

Value

Unified value enum representing any supported data structure.

Details

• Wraps scalar values, arrays, array windows, full tables, or table windows under a single type for function signatures and downstream dispatch.
• This can be useful when you need a global type universe.
• It is not part of the Arrow specification, but is useful because of the flexibility it adds unifying all types to a single one. For example, to return Result<Value, Error>, particularly in engine contexts.
• It’s enabled optionally via the value_type feature.

Usage

You can also use it to hold a custom type under the Custom entry. As long as the object implements Debug, Clone, and PartialEq, remains Send + Sync, and implements Any it can be stored in Value::Custom. Any is implemented automatically for all Rust types with a 'static lifetime.

Variants

Scalar(Scalar)

Array(Arc<Array>)

ArrayView(Arc<ArrayV>)

FieldArray(Arc<FieldArray>)

Table(Arc<Table>)

TableView(Arc<TableV>)

SuperArray(Arc<SuperArray>)

SuperArrayView(Arc<SuperArrayV>)

SuperTable(Arc<SuperTable>)

SuperTableView(Arc<SuperTableV>)

Matrix(Arc<Matrix>)

Cube(Arc<Cube>)

VecValue(Arc<Vec<Value>>)

BoxValue(Box<Value>)

ArcValue(Arc<Value>)

Tuple2(Arc<(Value, Value)>)

Tuple3(Arc<(Value, Value, Value)>)

Tuple4(Arc<(Value, Value, Value, Value)>)

Tuple5(Arc<(Value, Value, Value, Value, Value)>)

Tuple6(Arc<(Value, Value, Value, Value, Value, Value)>)

Custom(Arc<dyn CustomValue>)

Arbitrary user or library-defined payload.

As long as the object implements Debug, Clone, and PartialEq, remains Send + Sync, and implements Any it can be stored in Value::Custom. Any is implemented automatically for all Rust types with a 'static lifetime.

Borrowed values cannot be used directly. These must be wrapped in Arc or otherwise promoted to 'static to store inside Value.

It’s recommended that creators also implement From and TryFrom.

Implementations

impl Value

pub fn scalar(&self) -> &Scalar

Returns the inner Scalar if this is a Value::Scalar.

Panics if the value is not a Scalar variant.

pub fn try_scalar(&self) -> Result<&Scalar, MinarrowError>

Returns the inner Scalar if this is a Value::Scalar, or an error otherwise.

pub fn arr(&self) -> &Array

Returns the inner Array if this is a Value::Array.

Panics if the value is not an Array variant.

pub fn try_arr(&self) -> Result<&Array, MinarrowError>

Returns the inner Array if this is a Value::Array, or an error otherwise.

pub fn av(&self) -> &ArrayV

Returns the inner ArrayV if this is a Value::ArrayView.

Panics if the value is not an ArrayView variant.

pub fn try_av(&self) -> Result<&ArrayV, MinarrowError>

Returns the inner ArrayV if this is a Value::ArrayView, or an error otherwise.

pub fn fa(&self) -> &FieldArray

Returns the inner FieldArray if this is a Value::FieldArray.

Panics if the value is not a FieldArray variant.

pub fn try_fa(&self) -> Result<&FieldArray, MinarrowError>

Returns the inner FieldArray if this is a Value::FieldArray, or an error otherwise.

pub fn table(&self) -> &Table

Returns the inner Table if this is a Value::Table.

Panics if the value is not a Table variant.

pub fn try_table(&self) -> Result<&Table, MinarrowError>

Returns the inner Table if this is a Value::Table, or an error otherwise.

pub fn tv(&self) -> &TableV

Returns the inner TableV if this is a Value::TableView.

Panics if the value is not a TableView variant.

pub fn try_tv(&self) -> Result<&TableV, MinarrowError>

Returns the inner TableV if this is a Value::TableView, or an error otherwise.

pub fn sa(&self) -> &SuperArray

Returns the inner SuperArray if this is a Value::SuperArray.

Panics if the value is not a SuperArray variant.

pub fn try_sa(&self) -> Result<&SuperArray, MinarrowError>

Returns the inner SuperArray if this is a Value::SuperArray, or an error otherwise.

pub fn sav(&self) -> &SuperArrayV

Returns the inner SuperArrayV if this is a Value::SuperArrayView.

Panics if the value is not a SuperArrayView variant.

pub fn try_sav(&self) -> Result<&SuperArrayV, MinarrowError>

Returns the inner SuperArrayV if this is a Value::SuperArrayView, or an error otherwise.

pub fn st(&self) -> &SuperTable

Returns the inner SuperTable if this is a Value::SuperTable.

Panics if the value is not a SuperTable variant.

pub fn try_st(&self) -> Result<&SuperTable, MinarrowError>

Returns the inner SuperTable if this is a Value::SuperTable, or an error otherwise.

pub fn stv(&self) -> &SuperTableV

Returns the inner SuperTableV if this is a Value::SuperTableView.

Panics if the value is not a SuperTableView variant.

pub fn try_stv(&self) -> Result<&SuperTableV, MinarrowError>

Returns the inner SuperTableV if this is a Value::SuperTableView, or an error otherwise.

pub fn mat(&self) -> &Matrix

Returns the inner Matrix if this is a Value::Matrix.

Panics if the value is not a Matrix variant.

pub fn try_mat(&self) -> Result<&Matrix, MinarrowError>

Returns the inner Matrix if this is a Value::Matrix, or an error otherwise.

pub fn cube(&self) -> &Cube

Returns the inner Cube if this is a Value::Cube.

Panics if the value is not a Cube variant.

pub fn try_cube(&self) -> Result<&Cube, MinarrowError>

Returns the inner Cube if this is a Value::Cube, or an error otherwise.

pub fn vec_val(&self) -> &Vec<Value>

Returns the inner Vec<Value> if this is a Value::VecValue.

Panics if the value is not a VecValue variant.

pub fn try_vec_val(&self) -> Result<&Vec<Value>, MinarrowError>

Returns the inner Vec<Value> if this is a Value::VecValue, or an error otherwise.

pub fn box_val(&self) -> &Value

Returns the inner Value if this is a Value::BoxValue.

Panics if the value is not a BoxValue variant.

pub fn try_box_val(&self) -> Result<&Value, MinarrowError>

Returns the inner Value if this is a Value::BoxValue, or an error otherwise.

pub fn arc_val(&self) -> &Value

Returns the inner Value if this is a Value::ArcValue.

Panics if the value is not an ArcValue variant.

pub fn try_arc_val(&self) -> Result<&Value, MinarrowError>

Returns the inner Value if this is a Value::ArcValue, or an error otherwise.

pub fn t2(&self) -> &(Value, Value)

Returns the inner tuple if this is a Value::Tuple2.

Panics if the value is not a Tuple2 variant.

pub fn try_t2(&self) -> Result<&(Value, Value), MinarrowError>

Returns the inner tuple if this is a Value::Tuple2, or an error otherwise.

pub fn t3(&self) -> &(Value, Value, Value)

Returns the inner tuple if this is a Value::Tuple3.

Panics if the value is not a Tuple3 variant.

pub fn try_t3(&self) -> Result<&(Value, Value, Value), MinarrowError>

Returns the inner tuple if this is a Value::Tuple3, or an error otherwise.

pub fn t4(&self) -> &(Value, Value, Value, Value)

Returns the inner tuple if this is a Value::Tuple4.

Panics if the value is not a Tuple4 variant.

pub fn try_t4(&self) -> Result<&(Value, Value, Value, Value), MinarrowError>

Returns the inner tuple if this is a Value::Tuple4, or an error otherwise.

pub fn t5(&self) -> &(Value, Value, Value, Value, Value)

Returns the inner tuple if this is a Value::Tuple5.

Panics if the value is not a Tuple5 variant.

pub fn try_t5( &self, ) -> Result<&(Value, Value, Value, Value, Value), MinarrowError>

Returns the inner tuple if this is a Value::Tuple5, or an error otherwise.

pub fn t6(&self) -> &(Value, Value, Value, Value, Value, Value)

Returns the inner tuple if this is a Value::Tuple6.

Panics if the value is not a Tuple6 variant.

pub fn try_t6( &self, ) -> Result<&(Value, Value, Value, Value, Value, Value), MinarrowError>

Returns the inner tuple if this is a Value::Tuple6, or an error otherwise.

pub fn custom(&self) -> &dyn CustomValue

Returns the inner CustomValue trait object if this is a Value::Custom.

Panics if the value is not a Custom variant.

pub fn try_custom(&self) -> Result<&dyn CustomValue, MinarrowError>

Returns the inner CustomValue trait object if this is a Value::Custom, or an error otherwise.

impl Value

pub fn len(&self) -> usize

Computes the logical row/element count for the batch’s input Value.

This normalises the various Value representations so callers can consistently pass a [start, len) range to execute_fn.

pub fn is_empty(&self) -> bool

Returns true if the value is empty.

pub fn slice(&self, offset: usize, length: usize) -> Value

Returns a zero-copy view over [offset .. offset + length) rows of this Value.

For table and array types this returns the corresponding view variant. For scalars, returns a clone since they are dimensionless. For recursive wrappers, delegates to the inner value. For tuples, slices each element independently.

Trait Implementations

impl Add<&Value> for &Value

type Output = Result<Value, MinarrowError>

The resulting type after applying the + operator.

fn add(self, rhs: &Value) -> Self::Output

Performs the + operation.

impl Add for Value

type Output = Result<Value, MinarrowError>

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation.

impl ByteSize for Value

Available on crate feature value_type only.

ByteSize for Value enum - delegates to inner types

fn est_bytes(&self) -> usize

Returns the estimated byte size of this object in memory.

impl Clone for Value

fn clone(&self) -> Value

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Concatenate for Value

fn concat(self, other: Self) -> Result<Self, MinarrowError>

Concatenates self with other, consuming both and returning a new instance.

impl Debug for Value

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

Formats the value using the given formatter.

impl Div<&Value> for &Value

type Output = Result<Value, MinarrowError>

The resulting type after applying the / operator.

fn div(self, rhs: &Value) -> Self::Output

Performs the / operation.

impl Div for Value

type Output = Result<Value, MinarrowError>

The resulting type after applying the / operator.

fn div(self, rhs: Self) -> Self::Output

Performs the / operation.

impl From<(Value, Value)> for Value

fn from(v: (Value, Value)) -> Self

Converts to this type from the input type.

impl From<(Value, Value, Value)> for Value

fn from(v: (Value, Value, Value)) -> Self

Converts to this type from the input type.

impl From<(Value, Value, Value, Value)> for Value

fn from(v: (Value, Value, Value, Value)) -> Self

Converts to this type from the input type.

impl From<(Value, Value, Value, Value, Value)> for Value

fn from(v: (Value, Value, Value, Value, Value)) -> Self

Converts to this type from the input type.

impl From<(Value, Value, Value, Value, Value, Value)> for Value

fn from(v: (Value, Value, Value, Value, Value, Value)) -> Self

Converts to this type from the input type.

impl From<Array> for Value

fn from(v: Array) -> Self

Converts to this type from the input type.

impl From<ArrayV> for Value

Available on crate feature views only.

fn from(v: ArrayV) -> Self

Converts to this type from the input type.

impl From<Cube> for Value

Available on crate feature cube only.

fn from(v: Cube) -> Self

Converts to this type from the input type.

impl From<FieldArray> for Value

fn from(v: FieldArray) -> Self

Converts to this type from the input type.

impl From<Matrix> for Value

Available on crate feature matrix only.

fn from(v: Matrix) -> Self

Converts to this type from the input type.

impl From<Scalar> for Value

fn from(v: Scalar) -> Self

Converts to this type from the input type.

impl From<SuperArray> for Value

Available on crate feature chunked only.

fn from(v: SuperArray) -> Self

Converts to this type from the input type.

impl From<SuperArrayV> for Value

Available on crate features chunked and views only.

fn from(v: SuperArrayV) -> Self

Converts to this type from the input type.

impl From<SuperTable> for Value

Available on crate feature chunked only.

fn from(v: SuperTable) -> Self

Converts to this type from the input type.

impl From<Table> for Value

fn from(v: Table) -> Self

Converts to this type from the input type.

impl From<TableV> for Value

Available on crate feature views only.

fn from(v: TableV) -> Self

Converts to this type from the input type.

impl From<Vec<Value>> for Value

fn from(v: Vec<Value>) -> Self

Converts to this type from the input type.

impl FromIterator<Value> for Value

Collect Values back from an iterator.

Zero items produces an empty VecValue. A single item is returned directly. Multiple items are wrapped in VecValue.

fn from_iter<I: IntoIterator<Item = Value>>(iter: I) -> Self

Creates a value from an iterator.

impl IntoIterator for Value

Iterate over the elements of a Value.

VecValue yields its inner items. All other variants yield themselves as a single element, supporting keep-or-drop filter semantics.

type Item = Value

The type of the elements being iterated over.

type IntoIter = IntoIter<Value>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl Mul<&Value> for &Value

type Output = Result<Value, MinarrowError>

The resulting type after applying the * operator.

fn mul(self, rhs: &Value) -> Self::Output

Performs the * operation.

impl Mul for Value

type Output = Result<Value, MinarrowError>

The resulting type after applying the * operator.

fn mul(self, rhs: Self) -> Self::Output

Performs the * operation.

impl PartialEq for Value

Implements PartialEq for Value

This includes special handling for the Custom type.

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Rem<&Value> for &Value

type Output = Result<Value, MinarrowError>

The resulting type after applying the % operator.

fn rem(self, rhs: &Value) -> Self::Output

Performs the % operation.

impl Rem for Value

type Output = Result<Value, MinarrowError>

The resulting type after applying the % operator.

fn rem(self, rhs: Self) -> Self::Output

Performs the % operation.

impl Shape for Value

fn shape(&self) -> ShapeDim

Returns arbitrary Shape dimension for any data shape

fn shape_1d(&self) -> usize

Returns the first dimension shape

fn shape_2d(&self) -> (usize, usize)

Returns the first and second dimension shapes

fn shape_3d(&self) -> (usize, usize, usize)

Returns the first, second and third dimension shapes

fn shape_4d(&self) -> (usize, usize, usize, usize)

Returns the first, second, third and fourth dimension shapes

impl Sub<&Value> for &Value

type Output = Result<Value, MinarrowError>

The resulting type after applying the - operator.

fn sub(self, rhs: &Value) -> Self::Output

Performs the - operation.

impl Sub for Value

type Output = Result<Value, MinarrowError>

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self::Output

Performs the - operation.

impl TryFrom<Value> for (Value, Value)

type Error = MinarrowError

The type returned in the event of a conversion error.

fn try_from(v: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for (Value, Value, Value)

type Error = MinarrowError

The type returned in the event of a conversion error.

fn try_from(v: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for (Value, Value, Value, Value)

type Error = MinarrowError

The type returned in the event of a conversion error.

fn try_from(v: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for (Value, Value, Value, Value, Value)

type Error = MinarrowError

The type returned in the event of a conversion error.

fn try_from(v: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for (Value, Value, Value, Value, Value, Value)

type Error = MinarrowError

The type returned in the event of a conversion error.

fn try_from(v: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for Array

type Error = MinarrowError

The type returned in the event of a conversion error.

fn try_from(v: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for ArrayV

Available on crate feature views only.

type Error = MinarrowError

The type returned in the event of a conversion error.

fn try_from(v: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for Cube

Available on crate feature cube only.

type Error = MinarrowError

The type returned in the event of a conversion error.

fn try_from(v: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for FieldArray

type Error = MinarrowError

The type returned in the event of a conversion error.

fn try_from(v: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for Matrix

Available on crate feature matrix only.

type Error = MinarrowError

The type returned in the event of a conversion error.

fn try_from(v: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for NumericArrayV

Available on crate feature views only.

type Error = MinarrowError

The type returned in the event of a conversion error.

fn try_from(v: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for Option<bool>

type Error = MinarrowError

The type returned in the event of a conversion error.

fn try_from(v: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for Option<f32>

type Error = MinarrowError

The type returned in the event of a conversion error.

fn try_from(v: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for Option<f64>

type Error = MinarrowError

The type returned in the event of a conversion error.

fn try_from(v: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for Option<i32>

type Error = MinarrowError

The type returned in the event of a conversion error.

fn try_from(v: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for Option<i64>

type Error = MinarrowError

The type returned in the event of a conversion error.

fn try_from(v: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for Option<u32>

type Error = MinarrowError

The type returned in the event of a conversion error.

fn try_from(v: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for Option<u64>

type Error = MinarrowError

The type returned in the event of a conversion error.

fn try_from(v: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for Scalar

type Error = MinarrowError

The type returned in the event of a conversion error.

fn try_from(v: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for SuperArray

Available on crate feature chunked only.

type Error = MinarrowError

The type returned in the event of a conversion error.

fn try_from(v: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for SuperArrayV

Available on crate features chunked and views only.

type Error = MinarrowError

The type returned in the event of a conversion error.

fn try_from(v: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for SuperTable

Available on crate feature chunked only.

type Error = MinarrowError

The type returned in the event of a conversion error.

fn try_from(v: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for Table

type Error = MinarrowError

The type returned in the event of a conversion error.

fn try_from(v: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for TableV

Available on crate feature views only.

type Error = MinarrowError

The type returned in the event of a conversion error.

fn try_from(v: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for TemporalArrayV

Available on crate features views and datetime only.

type Error = MinarrowError

The type returned in the event of a conversion error.

fn try_from(v: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for TextArrayV

Available on crate feature views only.

type Error = MinarrowError

The type returned in the event of a conversion error.

fn try_from(v: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for Vec<Value>

type Error = MinarrowError

The type returned in the event of a conversion error.

fn try_from(v: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for bool

type Error = MinarrowError

The type returned in the event of a conversion error.

fn try_from(v: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for f32

type Error = MinarrowError

The type returned in the event of a conversion error.

fn try_from(v: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for f64

type Error = MinarrowError

The type returned in the event of a conversion error.

fn try_from(v: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for i32

type Error = MinarrowError

The type returned in the event of a conversion error.

fn try_from(v: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for i64

type Error = MinarrowError

The type returned in the event of a conversion error.

fn try_from(v: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for u32

type Error = MinarrowError

The type returned in the event of a conversion error.

fn try_from(v: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for u64

type Error = MinarrowError

The type returned in the event of a conversion error.

fn try_from(v: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for Value

Implements Eq for Value

Since PartialEq is reflexive, symmetric, and transitive for Value, we can safely implement Eq.