Struct vortex_array::array::TemporalArray

pub struct TemporalArray { /* private fields */ }

An array wrapper for primitive values that have an associated temporal meaning.

This is a wrapper around ExtensionArrays containing numeric types, each of which corresponds to either a timestamp or julian date (both referenced to UNIX epoch), OR a time since midnight.

Arrow compatibility

TemporalArray can be created from Arrow arrays containing the following datatypes:

• Time32
• Time64
• Timestamp
• Date32
• Date64

Anything that can be constructed and held in a TemporalArray can also be zero-copy converted back to the relevant Arrow datatype.

Implementations

impl TemporalArray

pub fn new_date(array: ArrayData, time_unit: TimeUnit) -> Self

Create a new TemporalArray holding either i32 day offsets, or i64 millisecond offsets that are evenly divisible by the number of 86,400,000.

This is equivalent to the data described by either of the Date32 or Date64 data types from Arrow.

Panics

If the time unit is milliseconds, and the array is not of primitive I64 type, it panics.

If the time unit is days, and the array is not of primitive I32 type, it panics.

If any other time unit is provided, it panics.

pub fn new_time(array: ArrayData, time_unit: TimeUnit) -> Self

Create a new TemporalArray holding one of the following values:

• i32 values representing seconds since midnight
• i32 values representing milliseconds since midnight
• i64 values representing microseconds since midnight
• i64 values representing nanoseconds since midnight

Note, this is equivalent to the set of values represented by the Time32 or Time64 types from Arrow.

Panics

If the time unit is seconds, and the array is not of primitive I32 type, it panics.

If the time unit is milliseconds, and the array is not of primitive I32 type, it panics.

If the time unit is microseconds, and the array is not of primitive I64 type, it panics.

If the time unit is nanoseconds, and the array is not of primitive I64 type, it panics.

pub fn new_timestamp( array: ArrayData, time_unit: TimeUnit, time_zone: Option<String>, ) -> Self

Create a new TemporalArray holding Arrow spec compliant Timestamp data, with an optional timezone.

Panics

If array does not hold Primitive i64 data, the function will panic.

If the time_unit is days, the function will panic.

impl TemporalArray

pub fn temporal_values(&self) -> ArrayData

Access the underlying temporal values in the underlying ExtensionArray storage.

These values are to be interpreted based on the time unit and optional time-zone stored in the TemporalMetadata.

pub fn temporal_metadata(&self) -> &TemporalMetadata

Retrieve the temporal metadata.

The metadata is used to provide semantic meaning to the temporal values Array, for example to understand the granularity of the samples and if they have an associated timezone.

pub fn ext_dtype(&self) -> Arc<ExtDType>

Retrieve the extension DType associated with the underlying array.

Trait Implementations

impl Clone for TemporalArray

fn clone(&self) -> TemporalArray

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TemporalArray

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

Formats the value using the given formatter.

impl From<&TemporalArray> for ExtensionArray

fn from(value: &TemporalArray) -> Self

Converts to this type from the input type.

impl From<TemporalArray> for ArrayData

fn from(value: TemporalArray) -> Self

Converts to this type from the input type.

impl From<TemporalArray> for ExtensionArray

fn from(value: TemporalArray) -> Self

Converts to this type from the input type.

impl TryFrom<ArrayData> for TemporalArray

fn try_from(value: ArrayData) -> 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<ExtensionArray> for TemporalArray

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(ext: ExtensionArray) -> Result<Self, Self::Error>

Performs the conversion.