Enum TemporalArray 

#[repr(C, align(64))]
pub enum TemporalArray {
    Datetime32(Arc<DatetimeArray<i32>>),
    Datetime64(Arc<DatetimeArray<i64>>),
    Null,
}

Temporal Array

Unified datetime array container

Purpose

Exists to unify datetime operations, simplify API’s and streamline user ergonomics.

Usage:

• It is accessible from Array using .dt(), and provides typed variant access via for e.g., .dt32(), so one can drill down to the required granularity via myarr.dt().dt32()
• This streamlines function implementations (at least for the NumericArray case where this pattern is the most useful), and, despite the additional enum layer, matching lanes in many real-world scenarios. This is because one can for e.g., unify a function signature with impl Into<TemporalArray>, and all of the subtypes, plus Array and TemporalArray, all qualify.
• Additionally, you can then use one Temporal implementation on the enum dispatch arm for all Temporal variants, or, in many cases, for the entire datetime arm when they are the same.

Handling Times, Durations, etc.

We use one Physical type to hold all datetime variants, i.e., the Apache Arrow types DATE32, TIME32, DURATION etc., and the Logical type is stored on the Field as metadata, given they otherwise have the same underlying data representation. To treat them differently in API usage, you can use the TimeUnit and IntervalUnit, along with the ArrowType that is stored on the Field in Minarrow, and match on these for any desired behaviour. The Field is packaged together with Array (which then drill-down accesses TemporalArray on the fly, or in dispatch routing scenarios).

Typecasting behaviour

• If the enum already holds the given type (which should be known at compile-time), then using accessors like .dt32() is zero-cost, as it transfers ownership.
• If you want to keep the original, of course use .clone() beforehand.
• If you use an accessor to a different base type, e.g., .dt64() when it’s a .dt32() already in the enum, it will convert it. Therefore, be mindful of performance when this occurs.

Variants

Datetime32(Arc<DatetimeArray<i32>>)

Datetime64(Arc<DatetimeArray<i64>>)

Null

Implementations

impl TemporalArray

pub fn len(&self) -> usize

Returns the logical length of the temporal array.

pub fn null_mask(&self) -> Option<&Bitmask>

Returns the underlying null mask, if any.

pub fn append_array(&mut self, other: &Self)

Appends all values (and null mask if present) from other into self.

Panics if the two arrays are of different variants or incompatible types.

This function uses copy-on-write semantics for arrays wrapped in Arc. If self is the only owner of its data, appends are performed in place without copying. If the array data is shared (Arc reference count > 1), the data is first cloned (so the mutation does not affect other owners), and the append is then performed on the unique copy.

This ensures that calling append_array never mutates data referenced elsewhere, but also avoids unnecessary cloning when the data is uniquely owned.

pub fn insert_rows( &mut self, index: usize, other: &Self, ) -> Result<(), MinarrowError>

Inserts all values (and null mask if present) from other into self at the specified index.

This is an O(n) operation.

Returns an error if the two arrays are of different variants or incompatible types, or if the index is out of bounds.

This function uses copy-on-write semantics for arrays wrapped in Arc.

pub fn split(self, index: usize) -> Result<(Self, Self), MinarrowError>

Splits the TemporalArray at the specified index, consuming self and returning two arrays.

pub fn dt32(self) -> Result<DatetimeArray<i32>, MinarrowError>

Returns an Arc<DatetimeArray> (casting if needed).

pub fn dt64(self) -> Result<DatetimeArray<i64>, MinarrowError>

Returns an Arc<DatetimeArray> (casting if needed).

Trait Implementations

impl ByteSize for TemporalArray

Available on crate feature datetime only.

ByteSize for TemporalArray enum (when datetime feature is enabled)

fn est_bytes(&self) -> usize

Returns the estimated byte size of this object in memory.

impl Clone for TemporalArray

fn clone(&self) -> TemporalArray

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Concatenate for TemporalArray

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

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

impl Debug for TemporalArray

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

Formats the value using the given formatter.

impl Default for TemporalArray

fn default() -> TemporalArray

Returns the “default value” for a type.

impl Display for TemporalArray

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

Formats the value using the given formatter.

impl From<TemporalArray> for TemporalArrayV

fn from(array: TemporalArray) -> Self

Converts to this type from the input type.

impl PartialEq for TemporalArray

fn eq(&self, other: &TemporalArray) -> 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 Shape for TemporalArray

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 StructuralPartialEq for TemporalArray