Trait TensorValue

pub trait TensorValue:
    Debug
    + Clone
    + PartialEq
    + PartialOrd
    + Send
    + Sync
    + 'static {
    type Array: Array + Clone + 'static;
    type Masked: TensorValue<Array = Self::Array>;
    type Unmasked: TensorValue<Array = Self::Array>;

    const TENSOR_TYPE: TensorType;
    const NULLABLE: bool;

    // Required methods
    fn value(array: &Self::Array, i: usize) -> Self;
    unsafe fn value_unchecked(array: &Self::Array, i: usize) -> Self;
    fn to_masked(value: Self) -> Self::Masked;
    fn to_unmasked(value: Self) -> Self::Unmasked;
    fn from_iter_masked<I>(iter: I) -> Self::Array
       where I: IntoIterator<Item = Self::Masked>;
    fn from_vec(values: Vec<Self>) -> Self::Array;
    unsafe fn from_trusted_len_iter_masked<I>(iter: I) -> Self::Array
       where I: IntoIterator<Item = Self::Masked>;
    fn slice(array: &Self::Array, offset: usize, length: usize) -> Self::Array;
    fn from_array_data(data: ArrayData) -> Self::Array;
    fn format(&self, f: &mut Formatter<'_>) -> Result;

    // Provided methods
    fn from_iter<I>(iter: I) -> Self::Array
       where I: IntoIterator<Item = Self> { ... }
    unsafe fn from_trusted_len_iter<I>(iter: I) -> Self::Array
       where I: IntoIterator<Item = Self> { ... }
}

A trait for data that can be stored as in a tensor.

Required Associated Constants

const TENSOR_TYPE: TensorType

const NULLABLE: bool

Whether this type is nullable/maskable. Should be false for all types except Option<T>.

Required Associated Types

type Array: Array + Clone + 'static

Arrow array type used to store raw values.

type Masked: TensorValue<Array = Self::Array>

Masked value type. For Option<T> this is Option<T>. For all other T this should be Option<T>.

type Unmasked: TensorValue<Array = Self::Array>

Unmasked value type. For Option<T> this is T. For all other T this should be T.

Required Methods

fn value(array: &Self::Array, i: usize) -> Self

Returns the value at index i in array. Panics if i >= array.len().

unsafe fn value_unchecked(array: &Self::Array, i: usize) -> Self

Returns the value at index i without bounds checking.

Safety

Calling this method where i >= array.len() is undefined behavior.

fn to_masked(value: Self) -> Self::Masked

Wrap value in its masked type.

For Option<T> this is a no-op. For all other types this returns Some(T).

fn to_unmasked(value: Self) -> Self::Unmasked

Unwrap the inner value from its masked type.

For Option<T> this method panics unless value is Some(T). For all other types this is a no-op.

fn from_iter_masked<I>(iter: I) -> Self::Array

where I: IntoIterator<Item = Self::Masked>,

Constructs an array from an iterator of masked values.

fn from_vec(values: Vec<Self>) -> Self::Array

unsafe fn from_trusted_len_iter_masked<I>(iter: I) -> Self::Array

where I: IntoIterator<Item = Self::Masked>,

Constructs an array from an iterator of masked values.

iter must implement ExactSizeIterator.

Safety

Calling this method with an iterator that doesn’t correctly report its length is undefined behavior.

fn slice(array: &Self::Array, offset: usize, length: usize) -> Self::Array

Returns a slice of array from offset to offset + length.

Panics if offset + length > array.len().

fn from_array_data(data: ArrayData) -> Self::Array

Constructs an array from ArrayData.

Panics if data is not convertable to Self::Array.

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

Writes the value of self to formatter f.

Provided Methods

fn from_iter<I>(iter: I) -> Self::Array

where I: IntoIterator<Item = Self>,

Constructs an array from an iterator of values.

unsafe fn from_trusted_len_iter<I>(iter: I) -> Self::Array

where I: IntoIterator<Item = Self>,

Constructs an array from an iterator of values.

iter must implement ExactSizeIterator.

Safety

Calling this method with an iterator that doesn’t correctly report its length is undefined behavior.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types

impl TensorValue for bool

const TENSOR_TYPE: TensorType = TensorType::Bool

const NULLABLE: bool = false

type Array = BooleanArray

type Masked = Option<bool>

type Unmasked = bool

fn value(array: &Self::Array, i: usize) -> Self

unsafe fn value_unchecked(array: &Self::Array, i: usize) -> Self

fn to_masked(value: Self) -> Self::Masked

fn to_unmasked(value: Self) -> Self::Unmasked

fn from_iter_masked<I>(iter: I) -> Self::Array

where I: IntoIterator<Item = Self::Masked>,

fn from_vec(values: Vec<Self>) -> Self::Array

unsafe fn from_trusted_len_iter_masked<I>(iter: I) -> Self::Array

where I: IntoIterator<Item = Self::Masked>,

fn slice(array: &Self::Array, offset: usize, length: usize) -> Self::Array

fn from_array_data(data: ArrayData) -> Self::Array

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

impl TensorValue for f32

const TENSOR_TYPE: TensorType = TensorType::Float32

const NULLABLE: bool = false

type Array = PrimitiveArray<Float32Type>

type Masked = Option<f32>

type Unmasked = f32

fn value(array: &Self::Array, i: usize) -> Self

unsafe fn value_unchecked(array: &Self::Array, i: usize) -> Self

fn to_masked(value: Self) -> Self::Masked

fn to_unmasked(value: Self) -> Self::Unmasked

fn from_iter_masked<I>(iter: I) -> Self::Array

where I: IntoIterator<Item = Self::Masked>,

fn from_vec(values: Vec<Self>) -> Self::Array

unsafe fn from_trusted_len_iter_masked<I>(iter: I) -> Self::Array

where I: IntoIterator<Item = Self::Masked>,

fn slice(array: &Self::Array, offset: usize, length: usize) -> Self::Array

fn from_array_data(data: ArrayData) -> Self::Array

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

impl TensorValue for f64

const TENSOR_TYPE: TensorType = TensorType::Float64

const NULLABLE: bool = false

type Array = PrimitiveArray<Float64Type>

type Masked = Option<f64>

type Unmasked = f64

fn value(array: &Self::Array, i: usize) -> Self

unsafe fn value_unchecked(array: &Self::Array, i: usize) -> Self

fn to_masked(value: Self) -> Self::Masked

fn to_unmasked(value: Self) -> Self::Unmasked

fn from_iter_masked<I>(iter: I) -> Self::Array

where I: IntoIterator<Item = Self::Masked>,

fn from_vec(values: Vec<Self>) -> Self::Array

unsafe fn from_trusted_len_iter_masked<I>(iter: I) -> Self::Array

where I: IntoIterator<Item = Self::Masked>,

fn slice(array: &Self::Array, offset: usize, length: usize) -> Self::Array

fn from_array_data(data: ArrayData) -> Self::Array

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

impl TensorValue for i8

const TENSOR_TYPE: TensorType = TensorType::Int8

const NULLABLE: bool = false

type Array = PrimitiveArray<Int8Type>

type Masked = Option<i8>

type Unmasked = i8

fn value(array: &Self::Array, i: usize) -> Self

unsafe fn value_unchecked(array: &Self::Array, i: usize) -> Self

fn to_masked(value: Self) -> Self::Masked

fn to_unmasked(value: Self) -> Self::Unmasked

fn from_iter_masked<I>(iter: I) -> Self::Array

where I: IntoIterator<Item = Self::Masked>,

fn from_vec(values: Vec<Self>) -> Self::Array

unsafe fn from_trusted_len_iter_masked<I>(iter: I) -> Self::Array

where I: IntoIterator<Item = Self::Masked>,

fn slice(array: &Self::Array, offset: usize, length: usize) -> Self::Array

fn from_array_data(data: ArrayData) -> Self::Array

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

impl TensorValue for i16

const TENSOR_TYPE: TensorType = TensorType::Int16

const NULLABLE: bool = false

type Array = PrimitiveArray<Int16Type>

type Masked = Option<i16>

type Unmasked = i16

fn value(array: &Self::Array, i: usize) -> Self

unsafe fn value_unchecked(array: &Self::Array, i: usize) -> Self

fn to_masked(value: Self) -> Self::Masked

fn to_unmasked(value: Self) -> Self::Unmasked

fn from_iter_masked<I>(iter: I) -> Self::Array

where I: IntoIterator<Item = Self::Masked>,

fn from_vec(values: Vec<Self>) -> Self::Array

unsafe fn from_trusted_len_iter_masked<I>(iter: I) -> Self::Array

where I: IntoIterator<Item = Self::Masked>,

fn slice(array: &Self::Array, offset: usize, length: usize) -> Self::Array

fn from_array_data(data: ArrayData) -> Self::Array

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

impl TensorValue for i32

const TENSOR_TYPE: TensorType = TensorType::Int32

const NULLABLE: bool = false

type Array = PrimitiveArray<Int32Type>

type Masked = Option<i32>

type Unmasked = i32

fn value(array: &Self::Array, i: usize) -> Self

unsafe fn value_unchecked(array: &Self::Array, i: usize) -> Self

fn to_masked(value: Self) -> Self::Masked

fn to_unmasked(value: Self) -> Self::Unmasked

fn from_iter_masked<I>(iter: I) -> Self::Array

where I: IntoIterator<Item = Self::Masked>,

fn from_vec(values: Vec<Self>) -> Self::Array

unsafe fn from_trusted_len_iter_masked<I>(iter: I) -> Self::Array

where I: IntoIterator<Item = Self::Masked>,

fn slice(array: &Self::Array, offset: usize, length: usize) -> Self::Array

fn from_array_data(data: ArrayData) -> Self::Array

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

impl TensorValue for i64

const TENSOR_TYPE: TensorType = TensorType::Int64

const NULLABLE: bool = false

type Array = PrimitiveArray<Int64Type>

type Masked = Option<i64>

type Unmasked = i64

fn value(array: &Self::Array, i: usize) -> Self

unsafe fn value_unchecked(array: &Self::Array, i: usize) -> Self

fn to_masked(value: Self) -> Self::Masked

fn to_unmasked(value: Self) -> Self::Unmasked

fn from_iter_masked<I>(iter: I) -> Self::Array

where I: IntoIterator<Item = Self::Masked>,

fn from_vec(values: Vec<Self>) -> Self::Array

unsafe fn from_trusted_len_iter_masked<I>(iter: I) -> Self::Array

where I: IntoIterator<Item = Self::Masked>,

fn slice(array: &Self::Array, offset: usize, length: usize) -> Self::Array

fn from_array_data(data: ArrayData) -> Self::Array

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

impl TensorValue for u8

const TENSOR_TYPE: TensorType = TensorType::UInt8

const NULLABLE: bool = false

type Array = PrimitiveArray<UInt8Type>

type Masked = Option<u8>

type Unmasked = u8

fn value(array: &Self::Array, i: usize) -> Self

unsafe fn value_unchecked(array: &Self::Array, i: usize) -> Self

fn to_masked(value: Self) -> Self::Masked

fn to_unmasked(value: Self) -> Self::Unmasked

fn from_iter_masked<I>(iter: I) -> Self::Array

where I: IntoIterator<Item = Self::Masked>,

fn from_vec(values: Vec<Self>) -> Self::Array

unsafe fn from_trusted_len_iter_masked<I>(iter: I) -> Self::Array

where I: IntoIterator<Item = Self::Masked>,

fn slice(array: &Self::Array, offset: usize, length: usize) -> Self::Array

fn from_array_data(data: ArrayData) -> Self::Array

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

impl TensorValue for u16

const TENSOR_TYPE: TensorType = TensorType::UInt16

const NULLABLE: bool = false

type Array = PrimitiveArray<UInt16Type>

type Masked = Option<u16>

type Unmasked = u16

fn value(array: &Self::Array, i: usize) -> Self

unsafe fn value_unchecked(array: &Self::Array, i: usize) -> Self

fn to_masked(value: Self) -> Self::Masked

fn to_unmasked(value: Self) -> Self::Unmasked

fn from_iter_masked<I>(iter: I) -> Self::Array

where I: IntoIterator<Item = Self::Masked>,

fn from_vec(values: Vec<Self>) -> Self::Array

unsafe fn from_trusted_len_iter_masked<I>(iter: I) -> Self::Array

where I: IntoIterator<Item = Self::Masked>,

fn slice(array: &Self::Array, offset: usize, length: usize) -> Self::Array

fn from_array_data(data: ArrayData) -> Self::Array

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

impl TensorValue for u32

const TENSOR_TYPE: TensorType = TensorType::UInt32

const NULLABLE: bool = false

type Array = PrimitiveArray<UInt32Type>

type Masked = Option<u32>

type Unmasked = u32

fn value(array: &Self::Array, i: usize) -> Self

unsafe fn value_unchecked(array: &Self::Array, i: usize) -> Self

fn to_masked(value: Self) -> Self::Masked

fn to_unmasked(value: Self) -> Self::Unmasked

fn from_iter_masked<I>(iter: I) -> Self::Array

where I: IntoIterator<Item = Self::Masked>,

fn from_vec(values: Vec<Self>) -> Self::Array

unsafe fn from_trusted_len_iter_masked<I>(iter: I) -> Self::Array

where I: IntoIterator<Item = Self::Masked>,

fn slice(array: &Self::Array, offset: usize, length: usize) -> Self::Array

fn from_array_data(data: ArrayData) -> Self::Array

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

impl TensorValue for u64

const TENSOR_TYPE: TensorType = TensorType::UInt64

const NULLABLE: bool = false

type Array = PrimitiveArray<UInt64Type>

type Masked = Option<u64>

type Unmasked = u64

fn value(array: &Self::Array, i: usize) -> Self

unsafe fn value_unchecked(array: &Self::Array, i: usize) -> Self

fn to_masked(value: Self) -> Self::Masked

fn to_unmasked(value: Self) -> Self::Unmasked

fn from_iter_masked<I>(iter: I) -> Self::Array

where I: IntoIterator<Item = Self::Masked>,

fn from_vec(values: Vec<Self>) -> Self::Array

unsafe fn from_trusted_len_iter_masked<I>(iter: I) -> Self::Array

where I: IntoIterator<Item = Self::Masked>,

fn slice(array: &Self::Array, offset: usize, length: usize) -> Self::Array

fn from_array_data(data: ArrayData) -> Self::Array

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

impl TensorValue for String

const TENSOR_TYPE: TensorType = TensorType::String

const NULLABLE: bool = false

type Array = GenericByteArray<GenericStringType<i32>>

type Masked = Option<String>

type Unmasked = String

fn value(array: &Self::Array, i: usize) -> Self

unsafe fn value_unchecked(array: &Self::Array, i: usize) -> Self

fn to_masked(value: Self) -> Self::Masked

fn to_unmasked(value: Self) -> Self::Unmasked

fn from_iter_masked<I>(iter: I) -> Self::Array

where I: IntoIterator<Item = Self::Masked>,

fn from_vec(values: Vec<Self>) -> Self::Array

unsafe fn from_trusted_len_iter_masked<I>(iter: I) -> Self::Array

where I: IntoIterator<Item = Self::Masked>,

fn slice(array: &Self::Array, offset: usize, length: usize) -> Self::Array

fn from_array_data(data: ArrayData) -> Self::Array

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

impl<T> TensorValue for Option<T>

where T: TensorValue<Masked = Self>,

const TENSOR_TYPE: TensorType = T::TENSOR_TYPE

const NULLABLE: bool = true

type Array = <T as TensorValue>::Array

type Masked = Option<T>

type Unmasked = T

fn value(array: &Self::Array, i: usize) -> Self

unsafe fn value_unchecked(array: &Self::Array, i: usize) -> Self

fn to_masked(value: Self) -> Self::Masked

fn to_unmasked(value: Self) -> Self::Unmasked

unsafe fn from_trusted_len_iter_masked<I>(iter: I) -> Self::Array

where I: IntoIterator<Item = Self::Masked>,

unsafe fn from_trusted_len_iter<I>(iter: I) -> Self::Array

where I: IntoIterator<Item = Self>,

fn from_iter_masked<I>(iter: I) -> Self::Array

where I: IntoIterator<Item = Self::Masked>,

fn from_vec(values: Vec<Self>) -> Self::Array

fn slice(array: &Self::Array, offset: usize, length: usize) -> Self::Array

fn from_array_data(data: ArrayData) -> Self::Array

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

Implementors

impl TensorValue for Duration

const TENSOR_TYPE: TensorType = TensorType::Duration

const NULLABLE: bool = false

type Array = PrimitiveArray<DurationNanosecondType>

type Masked = Option<Duration>

type Unmasked = Duration

impl TensorValue for OffsetDateTime

const TENSOR_TYPE: TensorType = TensorType::Timestamp

const NULLABLE: bool = false

type Array = PrimitiveArray<TimestampNanosecondType>

type Masked = Option<OffsetDateTime>

type Unmasked = OffsetDateTime

impl TensorValue for Time

const TENSOR_TYPE: TensorType = TensorType::Timestamp

const NULLABLE: bool = false

type Array = PrimitiveArray<TimestampNanosecondType>

type Masked = Option<Time>

type Unmasked = Time