Skip to main content

arrow_array/
types.rs

1// Licensed to the Apache Software Foundation (ASF) under one
2// or more contributor license agreements.  See the NOTICE file
3// distributed with this work for additional information
4// regarding copyright ownership.  The ASF licenses this file
5// to you under the Apache License, Version 2.0 (the
6// "License"); you may not use this file except in compliance
7// with the License.  You may obtain a copy of the License at
8//
9//   http://www.apache.org/licenses/LICENSE-2.0
10//
11// Unless required by applicable law or agreed to in writing,
12// software distributed under the License is distributed on an
13// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14// KIND, either express or implied.  See the License for the
15// specific language governing permissions and limitations
16// under the License.
17
18//! Zero-sized types used to parameterize generic array implementations
19
20use crate::delta::{
21    add_days_datetime, add_months_date, add_months_datetime, sub_days_datetime, sub_months_datetime,
22};
23use crate::temporal_conversions::as_datetime_with_timezone;
24use crate::timezone::Tz;
25use crate::{ArrowNativeTypeOp, OffsetSizeTrait};
26use arrow_buffer::{Buffer, OffsetBuffer, i256};
27use arrow_data::decimal::{
28    format_decimal_str, is_validate_decimal_precision, is_validate_decimal32_precision,
29    is_validate_decimal64_precision, is_validate_decimal256_precision, validate_decimal_precision,
30    validate_decimal32_precision, validate_decimal64_precision, validate_decimal256_precision,
31};
32use arrow_data::{validate_binary_view, validate_string_view};
33use arrow_schema::{
34    ArrowError, DECIMAL_DEFAULT_SCALE, DECIMAL32_DEFAULT_SCALE, DECIMAL32_MAX_PRECISION,
35    DECIMAL32_MAX_SCALE, DECIMAL64_DEFAULT_SCALE, DECIMAL64_MAX_PRECISION, DECIMAL64_MAX_SCALE,
36    DECIMAL128_MAX_PRECISION, DECIMAL128_MAX_SCALE, DECIMAL256_MAX_PRECISION, DECIMAL256_MAX_SCALE,
37    DataType, IntervalUnit, TimeUnit,
38};
39use chrono::{DateTime, Duration, NaiveDate, NaiveDateTime, TimeZone};
40use half::f16;
41use std::fmt::Debug;
42use std::marker::PhantomData;
43use std::ops::Sub;
44
45// re-export types so that they can be used without importing arrow_buffer explicitly
46pub use arrow_buffer::{IntervalDayTime, IntervalMonthDayNano};
47
48// BooleanType is special: its bit-width is not the size of the primitive type, and its `index`
49// operation assumes bit-packing.
50/// A boolean datatype
51#[derive(Debug)]
52pub struct BooleanType {}
53
54impl BooleanType {
55    /// The corresponding Arrow data type
56    pub const DATA_TYPE: DataType = DataType::Boolean;
57}
58
59/// Trait for [primitive values].
60///
61/// This trait bridges the dynamic-typed nature of Arrow
62/// (via [`DataType`]) with the static-typed nature of rust types
63/// ([`ArrowNativeType`]) for all types that implement [`ArrowNativeType`].
64///
65/// [primitive values]: https://arrow.apache.org/docs/format/Columnar.html#fixed-size-primitive-layout
66/// [`ArrowNativeType`]: arrow_buffer::ArrowNativeType
67pub trait ArrowPrimitiveType: primitive::PrimitiveTypeSealed + 'static {
68    /// Corresponding Rust native type for the primitive type.
69    type Native: ArrowNativeTypeOp;
70
71    /// the corresponding Arrow data type of this primitive type.
72    const DATA_TYPE: DataType;
73
74    /// Returns a default value of this primitive type.
75    ///
76    /// This is useful for aggregate array ops like `sum()`, `mean()`.
77    fn default_value() -> Self::Native {
78        Default::default()
79    }
80}
81
82mod primitive {
83    pub trait PrimitiveTypeSealed {}
84}
85
86macro_rules! make_type {
87    ($name:ident, $native_ty:ty, $data_ty:expr, $doc_string: literal) => {
88        #[derive(Debug)]
89        #[doc = $doc_string]
90        pub struct $name {}
91
92        impl ArrowPrimitiveType for $name {
93            type Native = $native_ty;
94            const DATA_TYPE: DataType = $data_ty;
95        }
96
97        impl primitive::PrimitiveTypeSealed for $name {}
98    };
99}
100
101make_type!(Int8Type, i8, DataType::Int8, "A signed 8-bit integer type.");
102make_type!(
103    Int16Type,
104    i16,
105    DataType::Int16,
106    "Signed 16-bit integer type."
107);
108make_type!(
109    Int32Type,
110    i32,
111    DataType::Int32,
112    "Signed 32-bit integer type."
113);
114make_type!(
115    Int64Type,
116    i64,
117    DataType::Int64,
118    "Signed 64-bit integer type."
119);
120make_type!(
121    UInt8Type,
122    u8,
123    DataType::UInt8,
124    "Unsigned 8-bit integer type."
125);
126make_type!(
127    UInt16Type,
128    u16,
129    DataType::UInt16,
130    "Unsigned 16-bit integer type."
131);
132make_type!(
133    UInt32Type,
134    u32,
135    DataType::UInt32,
136    "Unsigned 32-bit integer type."
137);
138make_type!(
139    UInt64Type,
140    u64,
141    DataType::UInt64,
142    "Unsigned 64-bit integer type."
143);
144make_type!(
145    Float16Type,
146    f16,
147    DataType::Float16,
148    "16-bit floating point number type."
149);
150make_type!(
151    Float32Type,
152    f32,
153    DataType::Float32,
154    "32-bit floating point number type."
155);
156make_type!(
157    Float64Type,
158    f64,
159    DataType::Float64,
160    "64-bit floating point number type."
161);
162make_type!(
163    TimestampSecondType,
164    i64,
165    DataType::Timestamp(TimeUnit::Second, None),
166    "Timestamp second type with an optional timezone."
167);
168make_type!(
169    TimestampMillisecondType,
170    i64,
171    DataType::Timestamp(TimeUnit::Millisecond, None),
172    "Timestamp millisecond type with an optional timezone."
173);
174make_type!(
175    TimestampMicrosecondType,
176    i64,
177    DataType::Timestamp(TimeUnit::Microsecond, None),
178    "Timestamp microsecond type with an optional timezone."
179);
180make_type!(
181    TimestampNanosecondType,
182    i64,
183    DataType::Timestamp(TimeUnit::Nanosecond, None),
184    "Timestamp nanosecond type with an optional timezone."
185);
186make_type!(
187    Date32Type,
188    i32,
189    DataType::Date32,
190    "32-bit date type: the elapsed time since UNIX epoch in days (32 bits)."
191);
192make_type!(
193    Date64Type,
194    i64,
195    DataType::Date64,
196    "64-bit date type: the elapsed time since UNIX epoch in milliseconds (64 bits). \
197    Values must be divisible by `86_400_000`. \
198    See [`DataType::Date64`] for more details."
199);
200make_type!(
201    Time32SecondType,
202    i32,
203    DataType::Time32(TimeUnit::Second),
204    "32-bit time type: the elapsed time since midnight in seconds."
205);
206make_type!(
207    Time32MillisecondType,
208    i32,
209    DataType::Time32(TimeUnit::Millisecond),
210    "32-bit time type: the elapsed time since midnight in milliseconds."
211);
212make_type!(
213    Time64MicrosecondType,
214    i64,
215    DataType::Time64(TimeUnit::Microsecond),
216    "64-bit time type: the elapsed time since midnight in microseconds."
217);
218make_type!(
219    Time64NanosecondType,
220    i64,
221    DataType::Time64(TimeUnit::Nanosecond),
222    "64-bit time type: the elapsed time since midnight in nanoseconds."
223);
224make_type!(
225    IntervalYearMonthType,
226    i32,
227    DataType::Interval(IntervalUnit::YearMonth),
228    "32-bit “calendar” interval type: the number of whole months."
229);
230make_type!(
231    IntervalDayTimeType,
232    IntervalDayTime,
233    DataType::Interval(IntervalUnit::DayTime),
234    "“Calendar” interval type: days and milliseconds. See [`IntervalDayTime`] for more details."
235);
236make_type!(
237    IntervalMonthDayNanoType,
238    IntervalMonthDayNano,
239    DataType::Interval(IntervalUnit::MonthDayNano),
240    r"“Calendar” interval type: months, days, and nanoseconds. See [`IntervalMonthDayNano`] for more details."
241);
242make_type!(
243    DurationSecondType,
244    i64,
245    DataType::Duration(TimeUnit::Second),
246    "Elapsed time type: seconds."
247);
248make_type!(
249    DurationMillisecondType,
250    i64,
251    DataType::Duration(TimeUnit::Millisecond),
252    "Elapsed time type: milliseconds."
253);
254make_type!(
255    DurationMicrosecondType,
256    i64,
257    DataType::Duration(TimeUnit::Microsecond),
258    "Elapsed time type: microseconds."
259);
260make_type!(
261    DurationNanosecondType,
262    i64,
263    DataType::Duration(TimeUnit::Nanosecond),
264    "Elapsed time type: nanoseconds."
265);
266
267/// A subtype of primitive type that represents legal dictionary keys.
268/// See <https://arrow.apache.org/docs/format/Columnar.html>
269pub trait ArrowDictionaryKeyType: ArrowPrimitiveType {}
270
271impl ArrowDictionaryKeyType for Int8Type {}
272
273impl ArrowDictionaryKeyType for Int16Type {}
274
275impl ArrowDictionaryKeyType for Int32Type {}
276
277impl ArrowDictionaryKeyType for Int64Type {}
278
279impl ArrowDictionaryKeyType for UInt8Type {}
280
281impl ArrowDictionaryKeyType for UInt16Type {}
282
283impl ArrowDictionaryKeyType for UInt32Type {}
284
285impl ArrowDictionaryKeyType for UInt64Type {}
286
287/// A subtype of primitive type that is used as run-ends index
288/// in `RunArray`.
289/// See <https://arrow.apache.org/docs/format/Columnar.html>
290pub trait RunEndIndexType: ArrowPrimitiveType {}
291
292impl RunEndIndexType for Int16Type {}
293
294impl RunEndIndexType for Int32Type {}
295
296impl RunEndIndexType for Int64Type {}
297
298/// A subtype of primitive type that represents temporal values.
299pub trait ArrowTemporalType: ArrowPrimitiveType {}
300
301impl ArrowTemporalType for TimestampSecondType {}
302impl ArrowTemporalType for TimestampMillisecondType {}
303impl ArrowTemporalType for TimestampMicrosecondType {}
304impl ArrowTemporalType for TimestampNanosecondType {}
305impl ArrowTemporalType for Date32Type {}
306impl ArrowTemporalType for Date64Type {}
307impl ArrowTemporalType for Time32SecondType {}
308impl ArrowTemporalType for Time32MillisecondType {}
309impl ArrowTemporalType for Time64MicrosecondType {}
310impl ArrowTemporalType for Time64NanosecondType {}
311// impl ArrowTemporalType for IntervalYearMonthType {}
312// impl ArrowTemporalType for IntervalDayTimeType {}
313// impl ArrowTemporalType for IntervalMonthDayNanoType {}
314impl ArrowTemporalType for DurationSecondType {}
315impl ArrowTemporalType for DurationMillisecondType {}
316impl ArrowTemporalType for DurationMicrosecondType {}
317impl ArrowTemporalType for DurationNanosecondType {}
318
319/// A timestamp type allows us to create array builders that take a timestamp.
320pub trait ArrowTimestampType: ArrowTemporalType<Native = i64> {
321    /// The [`TimeUnit`] of this timestamp.
322    const UNIT: TimeUnit;
323
324    /// Creates a ArrowTimestampType::Native from the provided [`NaiveDateTime`]
325    ///
326    /// See [`DataType::Timestamp`] for more information on timezone handling
327    #[deprecated(since = "58.1.0", note = "Use from_naive_datetime instead")]
328    fn make_value(naive: NaiveDateTime) -> Option<i64>;
329
330    /// Creates a timestamp value from a [`DateTime`] in any timezone.
331    ///
332    /// Returns `None` if the timestamp value would overflow the i64 range
333    /// (e.g., for nanosecond precision with extreme datetime values).
334    ///
335    /// # Arguments
336    ///
337    /// * `datetime` - The datetime to convert
338    fn from_datetime<Tz: TimeZone>(datetime: DateTime<Tz>) -> Option<i64>;
339
340    /// Creates a timestamp value from a [`NaiveDateTime`] interpreted in the given timezone.
341    ///
342    /// # Arguments
343    ///
344    /// * `naive` - The local datetime to convert
345    /// * `tz` - Optional timezone. If `None`, interprets as UTC
346    ///   (equivalent to calling [`Self::make_value`]).
347    fn from_naive_datetime(naive: NaiveDateTime, tz: Option<&Tz>) -> Option<i64> {
348        match tz {
349            Some(tz) => match tz.from_local_datetime(&naive) {
350                chrono::offset::LocalResult::Single(dt) => Self::from_datetime(dt),
351                chrono::offset::LocalResult::Ambiguous(dt1, _) => Self::from_datetime(dt1),
352                chrono::offset::LocalResult::None => None,
353            },
354            None => Self::from_datetime(naive.and_utc()),
355        }
356    }
357}
358
359impl ArrowTimestampType for TimestampSecondType {
360    const UNIT: TimeUnit = TimeUnit::Second;
361
362    fn make_value(naive: NaiveDateTime) -> Option<i64> {
363        Some(naive.and_utc().timestamp())
364    }
365
366    fn from_datetime<Tz: TimeZone>(datetime: DateTime<Tz>) -> Option<i64> {
367        Some(datetime.timestamp())
368    }
369}
370impl ArrowTimestampType for TimestampMillisecondType {
371    const UNIT: TimeUnit = TimeUnit::Millisecond;
372
373    fn make_value(naive: NaiveDateTime) -> Option<i64> {
374        let utc = naive.and_utc();
375        let millis = utc.timestamp().checked_mul(1_000)?;
376        millis.checked_add(utc.timestamp_subsec_millis() as i64)
377    }
378
379    fn from_datetime<Tz: TimeZone>(datetime: DateTime<Tz>) -> Option<i64> {
380        let millis = datetime.timestamp().checked_mul(1_000)?;
381        millis.checked_add(datetime.timestamp_subsec_millis() as i64)
382    }
383}
384impl ArrowTimestampType for TimestampMicrosecondType {
385    const UNIT: TimeUnit = TimeUnit::Microsecond;
386
387    fn make_value(naive: NaiveDateTime) -> Option<i64> {
388        let utc = naive.and_utc();
389        let micros = utc.timestamp().checked_mul(1_000_000)?;
390        micros.checked_add(utc.timestamp_subsec_micros() as i64)
391    }
392
393    fn from_datetime<Tz: TimeZone>(datetime: DateTime<Tz>) -> Option<i64> {
394        let micros = datetime.timestamp().checked_mul(1_000_000)?;
395        micros.checked_add(datetime.timestamp_subsec_micros() as i64)
396    }
397}
398impl ArrowTimestampType for TimestampNanosecondType {
399    const UNIT: TimeUnit = TimeUnit::Nanosecond;
400
401    fn make_value(naive: NaiveDateTime) -> Option<i64> {
402        let utc = naive.and_utc();
403        let nanos = utc.timestamp().checked_mul(1_000_000_000)?;
404        nanos.checked_add(utc.timestamp_subsec_nanos() as i64)
405    }
406
407    fn from_datetime<Tz: TimeZone>(datetime: DateTime<Tz>) -> Option<i64> {
408        datetime.timestamp_nanos_opt()
409    }
410}
411
412fn add_year_months<T: ArrowTimestampType>(
413    timestamp: <T as ArrowPrimitiveType>::Native,
414    delta: <IntervalYearMonthType as ArrowPrimitiveType>::Native,
415    tz: Tz,
416) -> Option<<T as ArrowPrimitiveType>::Native> {
417    let months = IntervalYearMonthType::to_months(delta);
418    let res = as_datetime_with_timezone::<T>(timestamp, tz)?;
419    let res = add_months_datetime(res, months)?;
420    T::from_naive_datetime(res.naive_utc(), None)
421}
422
423fn add_day_time<T: ArrowTimestampType>(
424    timestamp: <T as ArrowPrimitiveType>::Native,
425    delta: <IntervalDayTimeType as ArrowPrimitiveType>::Native,
426    tz: Tz,
427) -> Option<<T as ArrowPrimitiveType>::Native> {
428    let (days, ms) = IntervalDayTimeType::to_parts(delta);
429    let res = as_datetime_with_timezone::<T>(timestamp, tz)?;
430    let res = add_days_datetime(res, days)?;
431    let res = res.checked_add_signed(Duration::try_milliseconds(ms as i64)?)?;
432    T::from_naive_datetime(res.naive_utc(), None)
433}
434
435fn add_month_day_nano<T: ArrowTimestampType>(
436    timestamp: <T as ArrowPrimitiveType>::Native,
437    delta: <IntervalMonthDayNanoType as ArrowPrimitiveType>::Native,
438    tz: Tz,
439) -> Option<<T as ArrowPrimitiveType>::Native> {
440    let (months, days, nanos) = IntervalMonthDayNanoType::to_parts(delta);
441    let res = as_datetime_with_timezone::<T>(timestamp, tz)?;
442    let res = add_months_datetime(res, months)?;
443    let res = add_days_datetime(res, days)?;
444    let res = res.checked_add_signed(Duration::nanoseconds(nanos))?;
445    T::from_naive_datetime(res.naive_utc(), None)
446}
447
448fn subtract_year_months<T: ArrowTimestampType>(
449    timestamp: <T as ArrowPrimitiveType>::Native,
450    delta: <IntervalYearMonthType as ArrowPrimitiveType>::Native,
451    tz: Tz,
452) -> Option<<T as ArrowPrimitiveType>::Native> {
453    let months = IntervalYearMonthType::to_months(delta);
454    let res = as_datetime_with_timezone::<T>(timestamp, tz)?;
455    let res = sub_months_datetime(res, months)?;
456    T::from_naive_datetime(res.naive_utc(), None)
457}
458
459fn subtract_day_time<T: ArrowTimestampType>(
460    timestamp: <T as ArrowPrimitiveType>::Native,
461    delta: <IntervalDayTimeType as ArrowPrimitiveType>::Native,
462    tz: Tz,
463) -> Option<<T as ArrowPrimitiveType>::Native> {
464    let (days, ms) = IntervalDayTimeType::to_parts(delta);
465    let res = as_datetime_with_timezone::<T>(timestamp, tz)?;
466    let res = sub_days_datetime(res, days)?;
467    let res = res.checked_sub_signed(Duration::try_milliseconds(ms as i64)?)?;
468    T::from_naive_datetime(res.naive_utc(), None)
469}
470
471fn subtract_month_day_nano<T: ArrowTimestampType>(
472    timestamp: <T as ArrowPrimitiveType>::Native,
473    delta: <IntervalMonthDayNanoType as ArrowPrimitiveType>::Native,
474    tz: Tz,
475) -> Option<<T as ArrowPrimitiveType>::Native> {
476    let (months, days, nanos) = IntervalMonthDayNanoType::to_parts(delta);
477    let res = as_datetime_with_timezone::<T>(timestamp, tz)?;
478    let res = sub_months_datetime(res, months)?;
479    let res = sub_days_datetime(res, days)?;
480    let res = res.checked_sub_signed(Duration::nanoseconds(nanos))?;
481    T::from_naive_datetime(res.naive_utc(), None)
482}
483
484impl TimestampSecondType {
485    /// Adds the given IntervalYearMonthType to an arrow TimestampSecondType.
486    ///
487    /// Returns `None` when it will result in overflow.
488    ///
489    /// # Arguments
490    ///
491    /// * `timestamp` - The date on which to perform the operation
492    /// * `delta` - The interval to add
493    /// * `tz` - The timezone in which to interpret `timestamp`
494    pub fn add_year_months(
495        timestamp: <Self as ArrowPrimitiveType>::Native,
496        delta: <IntervalYearMonthType as ArrowPrimitiveType>::Native,
497        tz: Tz,
498    ) -> Option<<Self as ArrowPrimitiveType>::Native> {
499        add_year_months::<Self>(timestamp, delta, tz)
500    }
501
502    /// Adds the given IntervalDayTimeType to an arrow TimestampSecondType.
503    ///
504    /// Returns `None` when it will result in overflow.
505    ///
506    /// # Arguments
507    ///
508    /// * `timestamp` - The date on which to perform the operation
509    /// * `delta` - The interval to add
510    /// * `tz` - The timezone in which to interpret `timestamp`
511    pub fn add_day_time(
512        timestamp: <Self as ArrowPrimitiveType>::Native,
513        delta: <IntervalDayTimeType as ArrowPrimitiveType>::Native,
514        tz: Tz,
515    ) -> Option<<Self as ArrowPrimitiveType>::Native> {
516        add_day_time::<Self>(timestamp, delta, tz)
517    }
518
519    /// Adds the given IntervalMonthDayNanoType to an arrow TimestampSecondType
520    ///
521    /// Returns `None` when it will result in overflow.
522    /// # Arguments
523    ///
524    /// * `timestamp` - The date on which to perform the operation
525    /// * `delta` - The interval to add
526    /// * `tz` - The timezone in which to interpret `timestamp`
527    pub fn add_month_day_nano(
528        timestamp: <Self as ArrowPrimitiveType>::Native,
529        delta: <IntervalMonthDayNanoType as ArrowPrimitiveType>::Native,
530        tz: Tz,
531    ) -> Option<<Self as ArrowPrimitiveType>::Native> {
532        add_month_day_nano::<Self>(timestamp, delta, tz)
533    }
534
535    /// Subtracts the given IntervalYearMonthType to an arrow TimestampSecondType
536    ///
537    /// Returns `None` when it will result in overflow.
538    ///
539    /// # Arguments
540    ///
541    /// * `timestamp` - The date on which to perform the operation
542    /// * `delta` - The interval to add
543    /// * `tz` - The timezone in which to interpret `timestamp`
544    pub fn subtract_year_months(
545        timestamp: <Self as ArrowPrimitiveType>::Native,
546        delta: <IntervalYearMonthType as ArrowPrimitiveType>::Native,
547        tz: Tz,
548    ) -> Option<<Self as ArrowPrimitiveType>::Native> {
549        subtract_year_months::<Self>(timestamp, delta, tz)
550    }
551
552    /// Subtracts the given IntervalDayTimeType to an arrow TimestampSecondType
553    ///
554    /// Returns `None` when it will result in overflow.
555    ///
556    /// # Arguments
557    ///
558    /// * `timestamp` - The date on which to perform the operation
559    /// * `delta` - The interval to add
560    /// * `tz` - The timezone in which to interpret `timestamp`
561    pub fn subtract_day_time(
562        timestamp: <Self as ArrowPrimitiveType>::Native,
563        delta: <IntervalDayTimeType as ArrowPrimitiveType>::Native,
564        tz: Tz,
565    ) -> Option<<Self as ArrowPrimitiveType>::Native> {
566        subtract_day_time::<Self>(timestamp, delta, tz)
567    }
568
569    /// Subtracts the given IntervalMonthDayNanoType to an arrow TimestampSecondType
570    ///
571    /// Returns `None` when it will result in overflow.
572    ///
573    /// # Arguments
574    ///
575    /// * `timestamp` - The date on which to perform the operation
576    /// * `delta` - The interval to add
577    /// * `tz` - The timezone in which to interpret `timestamp`
578    pub fn subtract_month_day_nano(
579        timestamp: <Self as ArrowPrimitiveType>::Native,
580        delta: <IntervalMonthDayNanoType as ArrowPrimitiveType>::Native,
581        tz: Tz,
582    ) -> Option<<Self as ArrowPrimitiveType>::Native> {
583        subtract_month_day_nano::<Self>(timestamp, delta, tz)
584    }
585}
586
587impl TimestampMicrosecondType {
588    /// Adds the given IntervalYearMonthType to an arrow TimestampMicrosecondType
589    ///
590    /// # Arguments
591    ///
592    /// * `timestamp` - The date on which to perform the operation
593    /// * `delta` - The interval to add
594    /// * `tz` - The timezone in which to interpret `timestamp`
595    pub fn add_year_months(
596        timestamp: <Self as ArrowPrimitiveType>::Native,
597        delta: <IntervalYearMonthType as ArrowPrimitiveType>::Native,
598        tz: Tz,
599    ) -> Option<<Self as ArrowPrimitiveType>::Native> {
600        add_year_months::<Self>(timestamp, delta, tz)
601    }
602
603    /// Adds the given IntervalDayTimeType to an arrow TimestampMicrosecondType
604    ///
605    /// # Arguments
606    ///
607    /// * `timestamp` - The date on which to perform the operation
608    /// * `delta` - The interval to add
609    /// * `tz` - The timezone in which to interpret `timestamp`
610    pub fn add_day_time(
611        timestamp: <Self as ArrowPrimitiveType>::Native,
612        delta: <IntervalDayTimeType as ArrowPrimitiveType>::Native,
613        tz: Tz,
614    ) -> Option<<Self as ArrowPrimitiveType>::Native> {
615        add_day_time::<Self>(timestamp, delta, tz)
616    }
617
618    /// Adds the given IntervalMonthDayNanoType to an arrow TimestampMicrosecondType
619    ///
620    /// # Arguments
621    ///
622    /// * `timestamp` - The date on which to perform the operation
623    /// * `delta` - The interval to add
624    /// * `tz` - The timezone in which to interpret `timestamp`
625    pub fn add_month_day_nano(
626        timestamp: <Self as ArrowPrimitiveType>::Native,
627        delta: <IntervalMonthDayNanoType as ArrowPrimitiveType>::Native,
628        tz: Tz,
629    ) -> Option<<Self as ArrowPrimitiveType>::Native> {
630        add_month_day_nano::<Self>(timestamp, delta, tz)
631    }
632
633    /// Subtracts the given IntervalYearMonthType to an arrow TimestampMicrosecondType
634    ///
635    /// # Arguments
636    ///
637    /// * `timestamp` - The date on which to perform the operation
638    /// * `delta` - The interval to add
639    /// * `tz` - The timezone in which to interpret `timestamp`
640    pub fn subtract_year_months(
641        timestamp: <Self as ArrowPrimitiveType>::Native,
642        delta: <IntervalYearMonthType as ArrowPrimitiveType>::Native,
643        tz: Tz,
644    ) -> Option<<Self as ArrowPrimitiveType>::Native> {
645        subtract_year_months::<Self>(timestamp, delta, tz)
646    }
647
648    /// Subtracts the given IntervalDayTimeType to an arrow TimestampMicrosecondType
649    ///
650    /// # Arguments
651    ///
652    /// * `timestamp` - The date on which to perform the operation
653    /// * `delta` - The interval to add
654    /// * `tz` - The timezone in which to interpret `timestamp`
655    pub fn subtract_day_time(
656        timestamp: <Self as ArrowPrimitiveType>::Native,
657        delta: <IntervalDayTimeType as ArrowPrimitiveType>::Native,
658        tz: Tz,
659    ) -> Option<<Self as ArrowPrimitiveType>::Native> {
660        subtract_day_time::<Self>(timestamp, delta, tz)
661    }
662
663    /// Subtracts the given IntervalMonthDayNanoType to an arrow TimestampMicrosecondType
664    ///
665    /// # Arguments
666    ///
667    /// * `timestamp` - The date on which to perform the operation
668    /// * `delta` - The interval to add
669    /// * `tz` - The timezone in which to interpret `timestamp`
670    pub fn subtract_month_day_nano(
671        timestamp: <Self as ArrowPrimitiveType>::Native,
672        delta: <IntervalMonthDayNanoType as ArrowPrimitiveType>::Native,
673        tz: Tz,
674    ) -> Option<<Self as ArrowPrimitiveType>::Native> {
675        subtract_month_day_nano::<Self>(timestamp, delta, tz)
676    }
677}
678
679impl TimestampMillisecondType {
680    /// Adds the given IntervalYearMonthType to an arrow TimestampMillisecondType
681    ///
682    /// # Arguments
683    ///
684    /// * `timestamp` - The date on which to perform the operation
685    /// * `delta` - The interval to add
686    /// * `tz` - The timezone in which to interpret `timestamp`
687    pub fn add_year_months(
688        timestamp: <Self as ArrowPrimitiveType>::Native,
689        delta: <IntervalYearMonthType as ArrowPrimitiveType>::Native,
690        tz: Tz,
691    ) -> Option<<Self as ArrowPrimitiveType>::Native> {
692        add_year_months::<Self>(timestamp, delta, tz)
693    }
694
695    /// Adds the given IntervalDayTimeType to an arrow TimestampMillisecondType
696    ///
697    /// # Arguments
698    ///
699    /// * `timestamp` - The date on which to perform the operation
700    /// * `delta` - The interval to add
701    /// * `tz` - The timezone in which to interpret `timestamp`
702    pub fn add_day_time(
703        timestamp: <Self as ArrowPrimitiveType>::Native,
704        delta: <IntervalDayTimeType as ArrowPrimitiveType>::Native,
705        tz: Tz,
706    ) -> Option<<Self as ArrowPrimitiveType>::Native> {
707        add_day_time::<Self>(timestamp, delta, tz)
708    }
709
710    /// Adds the given IntervalMonthDayNanoType to an arrow TimestampMillisecondType
711    ///
712    /// # Arguments
713    ///
714    /// * `timestamp` - The date on which to perform the operation
715    /// * `delta` - The interval to add
716    /// * `tz` - The timezone in which to interpret `timestamp`
717    pub fn add_month_day_nano(
718        timestamp: <Self as ArrowPrimitiveType>::Native,
719        delta: <IntervalMonthDayNanoType as ArrowPrimitiveType>::Native,
720        tz: Tz,
721    ) -> Option<<Self as ArrowPrimitiveType>::Native> {
722        add_month_day_nano::<Self>(timestamp, delta, tz)
723    }
724
725    /// Subtracts the given IntervalYearMonthType to an arrow TimestampMillisecondType
726    ///
727    /// # Arguments
728    ///
729    /// * `timestamp` - The date on which to perform the operation
730    /// * `delta` - The interval to add
731    /// * `tz` - The timezone in which to interpret `timestamp`
732    pub fn subtract_year_months(
733        timestamp: <Self as ArrowPrimitiveType>::Native,
734        delta: <IntervalYearMonthType as ArrowPrimitiveType>::Native,
735        tz: Tz,
736    ) -> Option<<Self as ArrowPrimitiveType>::Native> {
737        subtract_year_months::<Self>(timestamp, delta, tz)
738    }
739
740    /// Subtracts the given IntervalDayTimeType to an arrow TimestampMillisecondType
741    ///
742    /// # Arguments
743    ///
744    /// * `timestamp` - The date on which to perform the operation
745    /// * `delta` - The interval to add
746    /// * `tz` - The timezone in which to interpret `timestamp`
747    pub fn subtract_day_time(
748        timestamp: <Self as ArrowPrimitiveType>::Native,
749        delta: <IntervalDayTimeType as ArrowPrimitiveType>::Native,
750        tz: Tz,
751    ) -> Option<<Self as ArrowPrimitiveType>::Native> {
752        subtract_day_time::<Self>(timestamp, delta, tz)
753    }
754
755    /// Subtracts the given IntervalMonthDayNanoType to an arrow TimestampMillisecondType
756    ///
757    /// # Arguments
758    ///
759    /// * `timestamp` - The date on which to perform the operation
760    /// * `delta` - The interval to add
761    /// * `tz` - The timezone in which to interpret `timestamp`
762    pub fn subtract_month_day_nano(
763        timestamp: <Self as ArrowPrimitiveType>::Native,
764        delta: <IntervalMonthDayNanoType as ArrowPrimitiveType>::Native,
765        tz: Tz,
766    ) -> Option<<Self as ArrowPrimitiveType>::Native> {
767        subtract_month_day_nano::<Self>(timestamp, delta, tz)
768    }
769}
770
771impl TimestampNanosecondType {
772    /// Adds the given IntervalYearMonthType to an arrow TimestampNanosecondType
773    ///
774    /// # Arguments
775    ///
776    /// * `timestamp` - The date on which to perform the operation
777    /// * `delta` - The interval to add
778    /// * `tz` - The timezone in which to interpret `timestamp`
779    pub fn add_year_months(
780        timestamp: <Self as ArrowPrimitiveType>::Native,
781        delta: <IntervalYearMonthType as ArrowPrimitiveType>::Native,
782        tz: Tz,
783    ) -> Option<<Self as ArrowPrimitiveType>::Native> {
784        add_year_months::<Self>(timestamp, delta, tz)
785    }
786
787    /// Adds the given IntervalDayTimeType to an arrow TimestampNanosecondType
788    ///
789    /// # Arguments
790    ///
791    /// * `timestamp` - The date on which to perform the operation
792    /// * `delta` - The interval to add
793    /// * `tz` - The timezone in which to interpret `timestamp`
794    pub fn add_day_time(
795        timestamp: <Self as ArrowPrimitiveType>::Native,
796        delta: <IntervalDayTimeType as ArrowPrimitiveType>::Native,
797        tz: Tz,
798    ) -> Option<<Self as ArrowPrimitiveType>::Native> {
799        add_day_time::<Self>(timestamp, delta, tz)
800    }
801
802    /// Adds the given IntervalMonthDayNanoType to an arrow TimestampNanosecondType
803    ///
804    /// # Arguments
805    ///
806    /// * `timestamp` - The date on which to perform the operation
807    /// * `delta` - The interval to add
808    /// * `tz` - The timezone in which to interpret `timestamp`
809    pub fn add_month_day_nano(
810        timestamp: <Self as ArrowPrimitiveType>::Native,
811        delta: <IntervalMonthDayNanoType as ArrowPrimitiveType>::Native,
812        tz: Tz,
813    ) -> Option<<Self as ArrowPrimitiveType>::Native> {
814        add_month_day_nano::<Self>(timestamp, delta, tz)
815    }
816
817    /// Subtracts the given IntervalYearMonthType to an arrow TimestampNanosecondType
818    ///
819    /// # Arguments
820    ///
821    /// * `timestamp` - The date on which to perform the operation
822    /// * `delta` - The interval to add
823    /// * `tz` - The timezone in which to interpret `timestamp`
824    pub fn subtract_year_months(
825        timestamp: <Self as ArrowPrimitiveType>::Native,
826        delta: <IntervalYearMonthType as ArrowPrimitiveType>::Native,
827        tz: Tz,
828    ) -> Option<<Self as ArrowPrimitiveType>::Native> {
829        subtract_year_months::<Self>(timestamp, delta, tz)
830    }
831
832    /// Subtracts the given IntervalDayTimeType to an arrow TimestampNanosecondType
833    ///
834    /// # Arguments
835    ///
836    /// * `timestamp` - The date on which to perform the operation
837    /// * `delta` - The interval to add
838    /// * `tz` - The timezone in which to interpret `timestamp`
839    pub fn subtract_day_time(
840        timestamp: <Self as ArrowPrimitiveType>::Native,
841        delta: <IntervalDayTimeType as ArrowPrimitiveType>::Native,
842        tz: Tz,
843    ) -> Option<<Self as ArrowPrimitiveType>::Native> {
844        subtract_day_time::<Self>(timestamp, delta, tz)
845    }
846
847    /// Subtracts the given IntervalMonthDayNanoType to an arrow TimestampNanosecondType
848    ///
849    /// # Arguments
850    ///
851    /// * `timestamp` - The date on which to perform the operation
852    /// * `delta` - The interval to add
853    /// * `tz` - The timezone in which to interpret `timestamp`
854    pub fn subtract_month_day_nano(
855        timestamp: <Self as ArrowPrimitiveType>::Native,
856        delta: <IntervalMonthDayNanoType as ArrowPrimitiveType>::Native,
857        tz: Tz,
858    ) -> Option<<Self as ArrowPrimitiveType>::Native> {
859        subtract_month_day_nano::<Self>(timestamp, delta, tz)
860    }
861}
862
863impl IntervalYearMonthType {
864    /// Creates a IntervalYearMonthType::Native
865    ///
866    /// # Arguments
867    ///
868    /// * `years` - The number of years (+/-) represented in this interval
869    /// * `months` - The number of months (+/-) represented in this interval
870    #[inline]
871    pub fn make_value(
872        years: i32,
873        months: i32,
874    ) -> <IntervalYearMonthType as ArrowPrimitiveType>::Native {
875        years * 12 + months
876    }
877
878    /// Turns a IntervalYearMonthType type into an i32 of months.
879    ///
880    /// This operation is technically a no-op, it is included for comprehensiveness.
881    ///
882    /// # Arguments
883    ///
884    /// * `i` - The IntervalYearMonthType::Native to convert
885    #[inline]
886    pub fn to_months(i: <IntervalYearMonthType as ArrowPrimitiveType>::Native) -> i32 {
887        i
888    }
889}
890
891impl IntervalDayTimeType {
892    /// Creates a IntervalDayTimeType::Native
893    ///
894    /// # Arguments
895    ///
896    /// * `days` - The number of days (+/-) represented in this interval
897    /// * `millis` - The number of milliseconds (+/-) represented in this interval
898    #[inline]
899    pub fn make_value(days: i32, milliseconds: i32) -> IntervalDayTime {
900        IntervalDayTime { days, milliseconds }
901    }
902
903    /// Turns a IntervalDayTimeType into a tuple of (days, milliseconds)
904    ///
905    /// # Arguments
906    ///
907    /// * `i` - The IntervalDayTimeType to convert
908    #[inline]
909    pub fn to_parts(i: IntervalDayTime) -> (i32, i32) {
910        (i.days, i.milliseconds)
911    }
912}
913
914impl IntervalMonthDayNanoType {
915    /// Creates a IntervalMonthDayNanoType::Native
916    ///
917    /// # Arguments
918    ///
919    /// * `months` - The number of months (+/-) represented in this interval
920    /// * `days` - The number of days (+/-) represented in this interval
921    /// * `nanos` - The number of nanoseconds (+/-) represented in this interval
922    #[inline]
923    pub fn make_value(months: i32, days: i32, nanoseconds: i64) -> IntervalMonthDayNano {
924        IntervalMonthDayNano {
925            months,
926            days,
927            nanoseconds,
928        }
929    }
930
931    /// Turns a IntervalMonthDayNanoType into a tuple of (months, days, nanos)
932    ///
933    /// # Arguments
934    ///
935    /// * `i` - The IntervalMonthDayNanoType to convert
936    #[inline]
937    pub fn to_parts(i: IntervalMonthDayNano) -> (i32, i32, i64) {
938        (i.months, i.days, i.nanoseconds)
939    }
940}
941
942impl Date32Type {
943    /// Converts an arrow Date32Type into a chrono::NaiveDate
944    ///
945    /// # Arguments
946    ///
947    /// * `i` - The Date32Type to convert
948    #[deprecated(since = "58.0.0", note = "Use to_naive_date_opt instead.")]
949    pub fn to_naive_date(i: <Date32Type as ArrowPrimitiveType>::Native) -> NaiveDate {
950        Self::to_naive_date_opt(i)
951            .unwrap_or_else(|| panic!("Date32Type::to_naive_date overflowed for date: {i}",))
952    }
953
954    /// Converts an arrow Date32Type into a chrono::NaiveDate
955    ///
956    /// # Arguments
957    ///
958    /// * `i` - The Date32Type to convert
959    ///
960    /// Returns `Some(NaiveDate)` if it fits, `None` otherwise.
961    pub fn to_naive_date_opt(i: <Date32Type as ArrowPrimitiveType>::Native) -> Option<NaiveDate> {
962        let epoch = NaiveDate::from_ymd_opt(1970, 1, 1).unwrap();
963        Duration::try_days(i as i64).and_then(|d| epoch.checked_add_signed(d))
964    }
965
966    /// Converts a chrono::NaiveDate into an arrow Date32Type
967    ///
968    /// # Arguments
969    ///
970    /// * `d` - The NaiveDate to convert
971    pub fn from_naive_date(d: NaiveDate) -> <Date32Type as ArrowPrimitiveType>::Native {
972        let epoch = NaiveDate::from_ymd_opt(1970, 1, 1).unwrap();
973        d.sub(epoch).num_days() as <Date32Type as ArrowPrimitiveType>::Native
974    }
975
976    /// Adds the given IntervalYearMonthType to an arrow Date32Type
977    ///
978    /// # Arguments
979    ///
980    /// * `date` - The date on which to perform the operation
981    /// * `delta` - The interval to add
982    #[deprecated(
983        since = "58.0.0",
984        note = "Use `add_year_months_opt` instead, which returns an Option to handle overflow."
985    )]
986    pub fn add_year_months(
987        date: <Date32Type as ArrowPrimitiveType>::Native,
988        delta: <IntervalYearMonthType as ArrowPrimitiveType>::Native,
989    ) -> <Date32Type as ArrowPrimitiveType>::Native {
990        Self::add_year_months_opt(date, delta).unwrap_or_else(|| {
991            panic!("Date32Type::add_year_months overflowed for date: {date}, delta: {delta}",)
992        })
993    }
994
995    /// Adds the given IntervalYearMonthType to an arrow Date32Type
996    ///
997    /// # Arguments
998    ///
999    /// * `date` - The date on which to perform the operation
1000    /// * `delta` - The interval to add
1001    ///
1002    /// Returns `Some(Date32Type)` if it fits, `None` otherwise.
1003    pub fn add_year_months_opt(
1004        date: <Date32Type as ArrowPrimitiveType>::Native,
1005        delta: <IntervalYearMonthType as ArrowPrimitiveType>::Native,
1006    ) -> Option<<Date32Type as ArrowPrimitiveType>::Native> {
1007        let prior = Date32Type::to_naive_date_opt(date)?;
1008        let months = IntervalYearMonthType::to_months(delta);
1009        let posterior = add_months_date(prior, months)?;
1010        Some(Date32Type::from_naive_date(posterior))
1011    }
1012
1013    /// Adds the given IntervalDayTimeType to an arrow Date32Type
1014    ///
1015    /// # Arguments
1016    ///
1017    /// * `date` - The date on which to perform the operation
1018    /// * `delta` - The interval to add
1019    #[deprecated(
1020        since = "58.0.0",
1021        note = "Use `add_day_time_opt` instead, which returns an Option to handle overflow."
1022    )]
1023    pub fn add_day_time(
1024        date: <Date32Type as ArrowPrimitiveType>::Native,
1025        delta: <IntervalDayTimeType as ArrowPrimitiveType>::Native,
1026    ) -> <Date32Type as ArrowPrimitiveType>::Native {
1027        Self::add_day_time_opt(date, delta).unwrap_or_else(|| {
1028            panic!("Date32Type::add_day_time overflowed for date: {date}, delta: {delta:?}",)
1029        })
1030    }
1031
1032    /// Adds the given IntervalDayTimeType to an arrow Date32Type
1033    ///
1034    /// # Arguments
1035    ///
1036    /// * `date` - The date on which to perform the operation
1037    /// * `delta` - The interval to add
1038    ///
1039    /// Returns `Some(Date32Type)` if it fits, `None` otherwise.
1040    pub fn add_day_time_opt(
1041        date: <Date32Type as ArrowPrimitiveType>::Native,
1042        delta: <IntervalDayTimeType as ArrowPrimitiveType>::Native,
1043    ) -> Option<<Date32Type as ArrowPrimitiveType>::Native> {
1044        let (days, ms) = IntervalDayTimeType::to_parts(delta);
1045        let res = Date32Type::to_naive_date_opt(date)?;
1046        let res = res.checked_add_signed(Duration::try_days(days as i64)?)?;
1047        let res = res.checked_add_signed(Duration::try_milliseconds(ms as i64)?)?;
1048        Some(Date32Type::from_naive_date(res))
1049    }
1050
1051    /// Adds the given IntervalMonthDayNanoType to an arrow Date32Type
1052    ///
1053    /// # Arguments
1054    ///
1055    /// * `date` - The date on which to perform the operation
1056    /// * `delta` - The interval to add
1057    #[deprecated(
1058        since = "58.0.0",
1059        note = "Use `add_month_day_nano_opt` instead, which returns an Option to handle overflow."
1060    )]
1061    pub fn add_month_day_nano(
1062        date: <Date32Type as ArrowPrimitiveType>::Native,
1063        delta: <IntervalMonthDayNanoType as ArrowPrimitiveType>::Native,
1064    ) -> <Date32Type as ArrowPrimitiveType>::Native {
1065        Self::add_month_day_nano_opt(date, delta).unwrap_or_else(|| {
1066            panic!("Date32Type::add_month_day_nano overflowed for date: {date}, delta: {delta:?}",)
1067        })
1068    }
1069
1070    /// Adds the given IntervalMonthDayNanoType to an arrow Date32Type
1071    ///
1072    /// # Arguments
1073    ///
1074    /// * `date` - The date on which to perform the operation
1075    /// * `delta` - The interval to add
1076    ///
1077    /// Returns `Some(Date32Type)` if it fits, `None` otherwise.
1078    pub fn add_month_day_nano_opt(
1079        date: <Date32Type as ArrowPrimitiveType>::Native,
1080        delta: <IntervalMonthDayNanoType as ArrowPrimitiveType>::Native,
1081    ) -> Option<<Date32Type as ArrowPrimitiveType>::Native> {
1082        let (months, days, nanos) = IntervalMonthDayNanoType::to_parts(delta);
1083        let res = Date32Type::to_naive_date_opt(date)?;
1084        let res = add_months_date(res, months)?;
1085        let res = res.checked_add_signed(Duration::try_days(days as i64)?)?;
1086        let res = res.checked_add_signed(Duration::nanoseconds(nanos))?;
1087        Some(Date32Type::from_naive_date(res))
1088    }
1089
1090    /// Subtract the given IntervalYearMonthType to an arrow Date32Type
1091    ///
1092    /// # Arguments
1093    ///
1094    /// * `date` - The date on which to perform the operation
1095    /// * `delta` - The interval to subtract
1096    #[deprecated(
1097        since = "58.0.0",
1098        note = "Use `subtract_year_months_opt` instead, which returns an Option to handle overflow."
1099    )]
1100    pub fn subtract_year_months(
1101        date: <Date32Type as ArrowPrimitiveType>::Native,
1102        delta: <IntervalYearMonthType as ArrowPrimitiveType>::Native,
1103    ) -> <Date32Type as ArrowPrimitiveType>::Native {
1104        Self::subtract_year_months_opt(date, delta).unwrap_or_else(|| {
1105            panic!("Date32Type::subtract_year_months overflowed for date: {date}, delta: {delta}",)
1106        })
1107    }
1108
1109    /// Subtract the given IntervalYearMonthType to an arrow Date32Type
1110    ///
1111    /// # Arguments
1112    ///
1113    /// * `date` - The date on which to perform the operation
1114    /// * `delta` - The interval to subtract
1115    ///
1116    /// Returns `Some(Date32Type)` if it fits, `None` otherwise.
1117    pub fn subtract_year_months_opt(
1118        date: <Date32Type as ArrowPrimitiveType>::Native,
1119        delta: <IntervalYearMonthType as ArrowPrimitiveType>::Native,
1120    ) -> Option<<Date32Type as ArrowPrimitiveType>::Native> {
1121        let prior = Date32Type::to_naive_date_opt(date)?;
1122        let months = IntervalYearMonthType::to_months(-delta);
1123        let posterior = add_months_date(prior, months)?;
1124        Some(Date32Type::from_naive_date(posterior))
1125    }
1126
1127    /// Subtract the given IntervalDayTimeType to an arrow Date32Type
1128    ///
1129    /// # Arguments
1130    ///
1131    /// * `date` - The date on which to perform the operation
1132    /// * `delta` - The interval to subtract
1133    #[deprecated(
1134        since = "58.0.0",
1135        note = "Use `subtract_day_time_opt` instead, which returns an Option to handle overflow."
1136    )]
1137    pub fn subtract_day_time(
1138        date: <Date32Type as ArrowPrimitiveType>::Native,
1139        delta: <IntervalDayTimeType as ArrowPrimitiveType>::Native,
1140    ) -> <Date32Type as ArrowPrimitiveType>::Native {
1141        Self::subtract_day_time_opt(date, delta).unwrap_or_else(|| {
1142            panic!("Date32Type::subtract_day_time overflowed for date: {date}, delta: {delta:?}",)
1143        })
1144    }
1145
1146    /// Subtract the given IntervalDayTimeType to an arrow Date32Type
1147    ///
1148    /// # Arguments
1149    ///
1150    /// * `date` - The date on which to perform the operation
1151    /// * `delta` - The interval to subtract
1152    ///
1153    /// Returns `Some(Date32Type)` if it fits, `None` otherwise.
1154    pub fn subtract_day_time_opt(
1155        date: <Date32Type as ArrowPrimitiveType>::Native,
1156        delta: <IntervalDayTimeType as ArrowPrimitiveType>::Native,
1157    ) -> Option<<Date32Type as ArrowPrimitiveType>::Native> {
1158        let (days, ms) = IntervalDayTimeType::to_parts(delta);
1159        let res = Date32Type::to_naive_date_opt(date)?;
1160        let res = res.checked_sub_signed(Duration::try_days(days as i64)?)?;
1161        let res = res.checked_sub_signed(Duration::try_milliseconds(ms as i64)?)?;
1162        Some(Date32Type::from_naive_date(res))
1163    }
1164
1165    /// Subtract the given IntervalMonthDayNanoType to an arrow Date32Type
1166    ///
1167    /// # Arguments
1168    ///
1169    /// * `date` - The date on which to perform the operation
1170    /// * `delta` - The interval to subtract
1171    #[deprecated(
1172        since = "58.0.0",
1173        note = "Use `subtract_month_day_nano_opt` instead, which returns an Option to handle overflow."
1174    )]
1175    pub fn subtract_month_day_nano(
1176        date: <Date32Type as ArrowPrimitiveType>::Native,
1177        delta: <IntervalMonthDayNanoType as ArrowPrimitiveType>::Native,
1178    ) -> <Date32Type as ArrowPrimitiveType>::Native {
1179        Self::subtract_month_day_nano_opt(date, delta).unwrap_or_else(|| {
1180            panic!(
1181                "Date32Type::subtract_month_day_nano overflowed for date: {date}, delta: {delta:?}",
1182            )
1183        })
1184    }
1185
1186    /// Subtract the given IntervalMonthDayNanoType to an arrow Date32Type
1187    ///
1188    /// # Arguments
1189    ///
1190    /// * `date` - The date on which to perform the operation
1191    /// * `delta` - The interval to subtract
1192    ///
1193    /// Returns `Some(Date32Type)` if it fits, `None` otherwise.
1194    pub fn subtract_month_day_nano_opt(
1195        date: <Date32Type as ArrowPrimitiveType>::Native,
1196        delta: <IntervalMonthDayNanoType as ArrowPrimitiveType>::Native,
1197    ) -> Option<<Date32Type as ArrowPrimitiveType>::Native> {
1198        let (months, days, nanos) = IntervalMonthDayNanoType::to_parts(delta);
1199        let res = Date32Type::to_naive_date_opt(date)?;
1200        let res = add_months_date(res, -months)?;
1201        let res = res.checked_sub_signed(Duration::try_days(days as i64)?)?;
1202        let res = res.checked_sub_signed(Duration::nanoseconds(nanos))?;
1203        Some(Date32Type::from_naive_date(res))
1204    }
1205}
1206
1207impl Date64Type {
1208    /// Converts an arrow Date64Type into a chrono::NaiveDateTime if it fits in the range that chrono::NaiveDateTime can represent.
1209    /// Returns `None` if the calculation would overflow or underflow.
1210    ///
1211    /// This function is able to handle dates ranging between 1677-09-21 (-9,223,372,800,000) and 2262-04-11 (9,223,286,400,000).
1212    ///
1213    /// # Arguments
1214    ///
1215    /// * `i` - The Date64Type to convert
1216    ///
1217    /// Returns `Some(NaiveDateTime)` if it fits, `None` otherwise.
1218    pub fn to_naive_date_opt(i: <Date64Type as ArrowPrimitiveType>::Native) -> Option<NaiveDate> {
1219        let epoch = NaiveDate::from_ymd_opt(1970, 1, 1).unwrap();
1220        Duration::try_milliseconds(i).and_then(|d| epoch.checked_add_signed(d))
1221    }
1222
1223    /// Converts a chrono::NaiveDate into an arrow Date64Type
1224    ///
1225    /// # Arguments
1226    ///
1227    /// * `d` - The NaiveDate to convert
1228    pub fn from_naive_date(d: NaiveDate) -> <Date64Type as ArrowPrimitiveType>::Native {
1229        let epoch = NaiveDate::from_ymd_opt(1970, 1, 1).unwrap();
1230        d.sub(epoch).num_milliseconds() as <Date64Type as ArrowPrimitiveType>::Native
1231    }
1232
1233    /// Adds the given IntervalYearMonthType to an arrow Date64Type
1234    ///
1235    /// # Arguments
1236    ///
1237    /// * `date` - The date on which to perform the operation
1238    /// * `delta` - The interval to add
1239    ///
1240    /// Returns `Some(Date64Type)` if it fits, `None` otherwise.
1241    pub fn add_year_months_opt(
1242        date: <Date64Type as ArrowPrimitiveType>::Native,
1243        delta: <IntervalYearMonthType as ArrowPrimitiveType>::Native,
1244    ) -> Option<<Date64Type as ArrowPrimitiveType>::Native> {
1245        let prior = Date64Type::to_naive_date_opt(date)?;
1246        let months = IntervalYearMonthType::to_months(delta);
1247        let posterior = add_months_date(prior, months)?;
1248        Some(Date64Type::from_naive_date(posterior))
1249    }
1250
1251    /// Adds the given IntervalDayTimeType to an arrow Date64Type
1252    ///
1253    /// # Arguments
1254    ///
1255    /// * `date` - The date on which to perform the operation
1256    /// * `delta` - The interval to add
1257    ///
1258    /// Returns `Some(Date64Type)` if it fits, `None` otherwise.
1259    pub fn add_day_time_opt(
1260        date: <Date64Type as ArrowPrimitiveType>::Native,
1261        delta: <IntervalDayTimeType as ArrowPrimitiveType>::Native,
1262    ) -> Option<<Date64Type as ArrowPrimitiveType>::Native> {
1263        let (days, ms) = IntervalDayTimeType::to_parts(delta);
1264        let res = Date64Type::to_naive_date_opt(date)?;
1265        let res = res.checked_add_signed(Duration::try_days(days as i64)?)?;
1266        let res = res.checked_add_signed(Duration::try_milliseconds(ms as i64)?)?;
1267        Some(Date64Type::from_naive_date(res))
1268    }
1269
1270    /// Adds the given IntervalMonthDayNanoType to an arrow Date64Type
1271    ///
1272    /// # Arguments
1273    ///
1274    /// * `date` - The date on which to perform the operation
1275    /// * `delta` - The interval to add
1276    ///
1277    /// Returns `Some(Date64Type)` if it fits, `None` otherwise.
1278    pub fn add_month_day_nano_opt(
1279        date: <Date64Type as ArrowPrimitiveType>::Native,
1280        delta: <IntervalMonthDayNanoType as ArrowPrimitiveType>::Native,
1281    ) -> Option<<Date64Type as ArrowPrimitiveType>::Native> {
1282        let (months, days, nanos) = IntervalMonthDayNanoType::to_parts(delta);
1283        let res = Date64Type::to_naive_date_opt(date)?;
1284        let res = add_months_date(res, months)?;
1285        let res = res.checked_add_signed(Duration::try_days(days as i64)?)?;
1286        let res = res.checked_add_signed(Duration::nanoseconds(nanos))?;
1287        Some(Date64Type::from_naive_date(res))
1288    }
1289
1290    /// Subtract the given IntervalYearMonthType to an arrow Date64Type
1291    ///
1292    /// # Arguments
1293    ///
1294    /// * `date` - The date on which to perform the operation
1295    /// * `delta` - The interval to subtract
1296    ///
1297    /// Returns `Some(Date64Type)` if it fits, `None` otherwise.
1298    pub fn subtract_year_months_opt(
1299        date: <Date64Type as ArrowPrimitiveType>::Native,
1300        delta: <IntervalYearMonthType as ArrowPrimitiveType>::Native,
1301    ) -> Option<<Date64Type as ArrowPrimitiveType>::Native> {
1302        let prior = Date64Type::to_naive_date_opt(date)?;
1303        let months = IntervalYearMonthType::to_months(-delta);
1304        let posterior = add_months_date(prior, months)?;
1305        Some(Date64Type::from_naive_date(posterior))
1306    }
1307
1308    /// Subtract the given IntervalDayTimeType to an arrow Date64Type
1309    ///
1310    /// # Arguments
1311    ///
1312    /// * `date` - The date on which to perform the operation
1313    /// * `delta` - The interval to subtract
1314    ///
1315    /// Returns `Some(Date64Type)` if it fits, `None` otherwise.
1316    pub fn subtract_day_time_opt(
1317        date: <Date64Type as ArrowPrimitiveType>::Native,
1318        delta: <IntervalDayTimeType as ArrowPrimitiveType>::Native,
1319    ) -> Option<<Date64Type as ArrowPrimitiveType>::Native> {
1320        let (days, ms) = IntervalDayTimeType::to_parts(delta);
1321        let res = Date64Type::to_naive_date_opt(date)?;
1322        let res = res.checked_sub_signed(Duration::try_days(days as i64)?)?;
1323        let res = res.checked_sub_signed(Duration::try_milliseconds(ms as i64)?)?;
1324        Some(Date64Type::from_naive_date(res))
1325    }
1326
1327    /// Subtract the given IntervalMonthDayNanoType to an arrow Date64Type
1328    ///
1329    /// # Arguments
1330    ///
1331    /// * `date` - The date on which to perform the operation
1332    /// * `delta` - The interval to subtract
1333    ///
1334    /// Returns `Some(Date64Type)` if it fits, `None` otherwise.
1335    pub fn subtract_month_day_nano_opt(
1336        date: <Date64Type as ArrowPrimitiveType>::Native,
1337        delta: <IntervalMonthDayNanoType as ArrowPrimitiveType>::Native,
1338    ) -> Option<<Date64Type as ArrowPrimitiveType>::Native> {
1339        let (months, days, nanos) = IntervalMonthDayNanoType::to_parts(delta);
1340        let res = Date64Type::to_naive_date_opt(date)?;
1341        let res = add_months_date(res, -months)?;
1342        let res = res.checked_sub_signed(Duration::try_days(days as i64)?)?;
1343        let res = res.checked_sub_signed(Duration::nanoseconds(nanos))?;
1344        Some(Date64Type::from_naive_date(res))
1345    }
1346}
1347
1348/// Crate private types for Decimal Arrays
1349///
1350/// Not intended to be used outside this crate
1351mod decimal {
1352    use super::*;
1353
1354    pub trait DecimalTypeSealed {}
1355    impl DecimalTypeSealed for Decimal32Type {}
1356    impl DecimalTypeSealed for Decimal64Type {}
1357    impl DecimalTypeSealed for Decimal128Type {}
1358    impl DecimalTypeSealed for Decimal256Type {}
1359}
1360
1361/// A trait over the decimal types, used by [`PrimitiveArray`] to provide a generic
1362/// implementation across the various decimal types
1363///
1364/// Implemented by [`Decimal32Type`], [`Decimal64Type`], [`Decimal128Type`] and [`Decimal256Type`]
1365/// for [`Decimal32Array`], [`Decimal64Array`], [`Decimal128Array`] and [`Decimal256Array`] respectively
1366///
1367/// [`PrimitiveArray`]: crate::array::PrimitiveArray
1368/// [`Decimal32Array`]: crate::array::Decimal32Array
1369/// [`Decimal64Array`]: crate::array::Decimal64Array
1370/// [`Decimal128Array`]: crate::array::Decimal128Array
1371/// [`Decimal256Array`]: crate::array::Decimal256Array
1372pub trait DecimalType:
1373    'static + Send + Sync + ArrowPrimitiveType + decimal::DecimalTypeSealed
1374{
1375    /// Width of the type
1376    const BYTE_LENGTH: usize;
1377    /// Maximum number of significant digits
1378    const MAX_PRECISION: u8;
1379    /// Maximum no of digits after the decimal point (note the scale can be negative)
1380    const MAX_SCALE: i8;
1381    /// The maximum value for each precision in `0..=MAX_PRECISION`: [0, 9, 99, ...]
1382    const MAX_FOR_EACH_PRECISION: &'static [Self::Native];
1383    /// fn to create its [`DataType`]
1384    const TYPE_CONSTRUCTOR: fn(u8, i8) -> DataType;
1385    /// Default values for [`DataType`]
1386    const DEFAULT_TYPE: DataType;
1387
1388    /// "Decimal32", "Decimal64", "Decimal128" or "Decimal256", for use in error messages
1389    const PREFIX: &'static str;
1390
1391    /// Formats the decimal value with the provided precision and scale
1392    fn format_decimal(value: Self::Native, precision: u8, scale: i8) -> String;
1393
1394    /// Validates that `value` contains no more than `precision` decimal digits
1395    fn validate_decimal_precision(
1396        value: Self::Native,
1397        precision: u8,
1398        scale: i8,
1399    ) -> Result<(), ArrowError>;
1400
1401    /// Determines whether `value` contains no more than `precision` decimal digits
1402    fn is_valid_decimal_precision(value: Self::Native, precision: u8) -> bool;
1403}
1404
1405/// Validate that `precision` and `scale` are valid for `T`
1406///
1407/// Returns an Error if:
1408/// - `precision` is zero
1409/// - `precision` is larger than `T:MAX_PRECISION`
1410/// - `scale` is larger than `T::MAX_SCALE`
1411/// - `scale` is > `precision`
1412pub fn validate_decimal_precision_and_scale<T: DecimalType>(
1413    precision: u8,
1414    scale: i8,
1415) -> Result<(), ArrowError> {
1416    if precision == 0 {
1417        return Err(ArrowError::InvalidArgumentError(format!(
1418            "precision cannot be 0, has to be between [1, {}]",
1419            T::MAX_PRECISION
1420        )));
1421    }
1422    if precision > T::MAX_PRECISION {
1423        return Err(ArrowError::InvalidArgumentError(format!(
1424            "precision {} is greater than max {}",
1425            precision,
1426            T::MAX_PRECISION
1427        )));
1428    }
1429    if scale > T::MAX_SCALE {
1430        return Err(ArrowError::InvalidArgumentError(format!(
1431            "scale {} is greater than max {}",
1432            scale,
1433            T::MAX_SCALE
1434        )));
1435    }
1436    if scale > 0 && scale as u8 > precision {
1437        return Err(ArrowError::InvalidArgumentError(format!(
1438            "scale {scale} is greater than precision {precision}"
1439        )));
1440    }
1441
1442    Ok(())
1443}
1444
1445/// The decimal type for a Decimal32Array
1446#[derive(Debug)]
1447pub struct Decimal32Type {}
1448
1449impl DecimalType for Decimal32Type {
1450    const BYTE_LENGTH: usize = 4;
1451    const MAX_PRECISION: u8 = DECIMAL32_MAX_PRECISION;
1452    const MAX_SCALE: i8 = DECIMAL32_MAX_SCALE;
1453    const MAX_FOR_EACH_PRECISION: &'static [i32] =
1454        &arrow_data::decimal::MAX_DECIMAL32_FOR_EACH_PRECISION;
1455    const TYPE_CONSTRUCTOR: fn(u8, i8) -> DataType = DataType::Decimal32;
1456    const DEFAULT_TYPE: DataType =
1457        DataType::Decimal32(DECIMAL32_MAX_PRECISION, DECIMAL32_DEFAULT_SCALE);
1458    const PREFIX: &'static str = "Decimal32";
1459
1460    fn format_decimal(value: Self::Native, precision: u8, scale: i8) -> String {
1461        format_decimal_str(&value.to_string(), precision as usize, scale)
1462    }
1463
1464    fn validate_decimal_precision(num: i32, precision: u8, scale: i8) -> Result<(), ArrowError> {
1465        validate_decimal32_precision(num, precision, scale)
1466    }
1467
1468    fn is_valid_decimal_precision(value: Self::Native, precision: u8) -> bool {
1469        is_validate_decimal32_precision(value, precision)
1470    }
1471}
1472
1473impl ArrowPrimitiveType for Decimal32Type {
1474    type Native = i32;
1475
1476    const DATA_TYPE: DataType = <Self as DecimalType>::DEFAULT_TYPE;
1477}
1478
1479impl primitive::PrimitiveTypeSealed for Decimal32Type {}
1480
1481/// The decimal type for a Decimal64Array
1482#[derive(Debug)]
1483pub struct Decimal64Type {}
1484
1485impl DecimalType for Decimal64Type {
1486    const BYTE_LENGTH: usize = 8;
1487    const MAX_PRECISION: u8 = DECIMAL64_MAX_PRECISION;
1488    const MAX_SCALE: i8 = DECIMAL64_MAX_SCALE;
1489    const MAX_FOR_EACH_PRECISION: &'static [i64] =
1490        &arrow_data::decimal::MAX_DECIMAL64_FOR_EACH_PRECISION;
1491    const TYPE_CONSTRUCTOR: fn(u8, i8) -> DataType = DataType::Decimal64;
1492    const DEFAULT_TYPE: DataType =
1493        DataType::Decimal64(DECIMAL64_MAX_PRECISION, DECIMAL64_DEFAULT_SCALE);
1494    const PREFIX: &'static str = "Decimal64";
1495
1496    fn format_decimal(value: Self::Native, precision: u8, scale: i8) -> String {
1497        format_decimal_str(&value.to_string(), precision as usize, scale)
1498    }
1499
1500    fn validate_decimal_precision(num: i64, precision: u8, scale: i8) -> Result<(), ArrowError> {
1501        validate_decimal64_precision(num, precision, scale)
1502    }
1503
1504    fn is_valid_decimal_precision(value: Self::Native, precision: u8) -> bool {
1505        is_validate_decimal64_precision(value, precision)
1506    }
1507}
1508
1509impl ArrowPrimitiveType for Decimal64Type {
1510    type Native = i64;
1511
1512    const DATA_TYPE: DataType = <Self as DecimalType>::DEFAULT_TYPE;
1513}
1514
1515impl primitive::PrimitiveTypeSealed for Decimal64Type {}
1516
1517/// The decimal type for a Decimal128Array
1518#[derive(Debug)]
1519pub struct Decimal128Type {}
1520
1521impl DecimalType for Decimal128Type {
1522    const BYTE_LENGTH: usize = 16;
1523    const MAX_PRECISION: u8 = DECIMAL128_MAX_PRECISION;
1524    const MAX_SCALE: i8 = DECIMAL128_MAX_SCALE;
1525    const MAX_FOR_EACH_PRECISION: &'static [i128] =
1526        &arrow_data::decimal::MAX_DECIMAL128_FOR_EACH_PRECISION;
1527    const TYPE_CONSTRUCTOR: fn(u8, i8) -> DataType = DataType::Decimal128;
1528    const DEFAULT_TYPE: DataType =
1529        DataType::Decimal128(DECIMAL128_MAX_PRECISION, DECIMAL_DEFAULT_SCALE);
1530    const PREFIX: &'static str = "Decimal128";
1531
1532    fn format_decimal(value: Self::Native, precision: u8, scale: i8) -> String {
1533        format_decimal_str(&value.to_string(), precision as usize, scale)
1534    }
1535
1536    fn validate_decimal_precision(num: i128, precision: u8, scale: i8) -> Result<(), ArrowError> {
1537        validate_decimal_precision(num, precision, scale)
1538    }
1539
1540    fn is_valid_decimal_precision(value: Self::Native, precision: u8) -> bool {
1541        is_validate_decimal_precision(value, precision)
1542    }
1543}
1544
1545impl ArrowPrimitiveType for Decimal128Type {
1546    type Native = i128;
1547
1548    const DATA_TYPE: DataType = <Self as DecimalType>::DEFAULT_TYPE;
1549}
1550
1551impl primitive::PrimitiveTypeSealed for Decimal128Type {}
1552
1553/// The decimal type for a Decimal256Array
1554#[derive(Debug)]
1555pub struct Decimal256Type {}
1556
1557impl DecimalType for Decimal256Type {
1558    const BYTE_LENGTH: usize = 32;
1559    const MAX_PRECISION: u8 = DECIMAL256_MAX_PRECISION;
1560    const MAX_SCALE: i8 = DECIMAL256_MAX_SCALE;
1561    const MAX_FOR_EACH_PRECISION: &'static [i256] =
1562        &arrow_data::decimal::MAX_DECIMAL256_FOR_EACH_PRECISION;
1563    const TYPE_CONSTRUCTOR: fn(u8, i8) -> DataType = DataType::Decimal256;
1564    const DEFAULT_TYPE: DataType =
1565        DataType::Decimal256(DECIMAL256_MAX_PRECISION, DECIMAL_DEFAULT_SCALE);
1566    const PREFIX: &'static str = "Decimal256";
1567
1568    fn format_decimal(value: Self::Native, precision: u8, scale: i8) -> String {
1569        format_decimal_str(&value.to_string(), precision as usize, scale)
1570    }
1571
1572    fn validate_decimal_precision(num: i256, precision: u8, scale: i8) -> Result<(), ArrowError> {
1573        validate_decimal256_precision(num, precision, scale)
1574    }
1575
1576    fn is_valid_decimal_precision(value: Self::Native, precision: u8) -> bool {
1577        is_validate_decimal256_precision(value, precision)
1578    }
1579}
1580
1581impl ArrowPrimitiveType for Decimal256Type {
1582    type Native = i256;
1583
1584    const DATA_TYPE: DataType = <Self as DecimalType>::DEFAULT_TYPE;
1585}
1586
1587impl primitive::PrimitiveTypeSealed for Decimal256Type {}
1588
1589/// Crate private types for Byte Arrays
1590///
1591/// Not intended to be used outside this crate
1592pub(crate) mod bytes {
1593    use super::*;
1594
1595    pub trait ByteArrayTypeSealed {}
1596    impl<O: OffsetSizeTrait> ByteArrayTypeSealed for GenericStringType<O> {}
1597    impl<O: OffsetSizeTrait> ByteArrayTypeSealed for GenericBinaryType<O> {}
1598
1599    pub trait ByteArrayNativeType: std::fmt::Debug + Send + Sync {
1600        fn from_bytes_checked(b: &[u8]) -> Option<&Self>;
1601
1602        /// # Safety
1603        ///
1604        /// `b` must be a valid byte sequence for `Self`
1605        unsafe fn from_bytes_unchecked(b: &[u8]) -> &Self;
1606    }
1607
1608    impl ByteArrayNativeType for [u8] {
1609        #[inline]
1610        fn from_bytes_checked(b: &[u8]) -> Option<&Self> {
1611            Some(b)
1612        }
1613
1614        #[inline]
1615        unsafe fn from_bytes_unchecked(b: &[u8]) -> &Self {
1616            b
1617        }
1618    }
1619
1620    impl ByteArrayNativeType for str {
1621        #[inline]
1622        fn from_bytes_checked(b: &[u8]) -> Option<&Self> {
1623            std::str::from_utf8(b).ok()
1624        }
1625
1626        #[inline]
1627        unsafe fn from_bytes_unchecked(b: &[u8]) -> &Self {
1628            unsafe { std::str::from_utf8_unchecked(b) }
1629        }
1630    }
1631}
1632
1633/// A trait over the variable-size byte array types
1634///
1635/// See [Variable Size Binary Layout](https://arrow.apache.org/docs/format/Columnar.html#variable-size-binary-layout)
1636pub trait ByteArrayType: 'static + Send + Sync + bytes::ByteArrayTypeSealed {
1637    /// Type of offset i.e i32/i64
1638    type Offset: OffsetSizeTrait;
1639    /// Type for representing its equivalent rust type i.e
1640    /// Utf8Array will have native type has &str
1641    /// BinaryArray will have type as [u8]
1642    type Native: bytes::ByteArrayNativeType + AsRef<Self::Native> + AsRef<[u8]> + ?Sized;
1643
1644    /// "Binary" or "String", for use in error messages
1645    const PREFIX: &'static str;
1646
1647    /// Datatype of array elements
1648    const DATA_TYPE: DataType;
1649
1650    /// Verifies that every consecutive pair of `offsets` denotes a valid slice of `values`
1651    fn validate(offsets: &OffsetBuffer<Self::Offset>, values: &Buffer) -> Result<(), ArrowError>;
1652}
1653
1654/// [`ByteArrayType`] for string arrays
1655pub struct GenericStringType<O: OffsetSizeTrait> {
1656    phantom: PhantomData<O>,
1657}
1658
1659impl<O: OffsetSizeTrait> ByteArrayType for GenericStringType<O> {
1660    type Offset = O;
1661    type Native = str;
1662    const PREFIX: &'static str = "String";
1663
1664    const DATA_TYPE: DataType = if O::IS_LARGE {
1665        DataType::LargeUtf8
1666    } else {
1667        DataType::Utf8
1668    };
1669
1670    fn validate(offsets: &OffsetBuffer<Self::Offset>, values: &Buffer) -> Result<(), ArrowError> {
1671        // Verify that the slice as a whole is valid UTF-8
1672        let validated = std::str::from_utf8(values).map_err(|e| {
1673            ArrowError::InvalidArgumentError(format!("Encountered non UTF-8 data: {e}"))
1674        })?;
1675
1676        // Verify each offset is at a valid character boundary in this UTF-8 array
1677        for offset in offsets.iter() {
1678            let o = offset.as_usize();
1679            if !validated.is_char_boundary(o) {
1680                if o < validated.len() {
1681                    return Err(ArrowError::InvalidArgumentError(format!(
1682                        "Split UTF-8 codepoint at offset {o}"
1683                    )));
1684                }
1685                return Err(ArrowError::InvalidArgumentError(format!(
1686                    "Offset of {o} exceeds length of values {}",
1687                    validated.len()
1688                )));
1689            }
1690        }
1691        Ok(())
1692    }
1693}
1694
1695/// An arrow utf8 array with i32 offsets
1696pub type Utf8Type = GenericStringType<i32>;
1697/// An arrow utf8 array with i64 offsets
1698pub type LargeUtf8Type = GenericStringType<i64>;
1699
1700/// [`ByteArrayType`] for binary arrays
1701pub struct GenericBinaryType<O: OffsetSizeTrait> {
1702    phantom: PhantomData<O>,
1703}
1704
1705impl<O: OffsetSizeTrait> ByteArrayType for GenericBinaryType<O> {
1706    type Offset = O;
1707    type Native = [u8];
1708    const PREFIX: &'static str = "Binary";
1709
1710    const DATA_TYPE: DataType = if O::IS_LARGE {
1711        DataType::LargeBinary
1712    } else {
1713        DataType::Binary
1714    };
1715
1716    fn validate(offsets: &OffsetBuffer<Self::Offset>, values: &Buffer) -> Result<(), ArrowError> {
1717        // offsets are guaranteed to be monotonically increasing and non-empty
1718        let max_offset = offsets.last().unwrap().as_usize();
1719        if values.len() < max_offset {
1720            return Err(ArrowError::InvalidArgumentError(format!(
1721                "Maximum offset of {max_offset} is larger than values of length {}",
1722                values.len()
1723            )));
1724        }
1725        Ok(())
1726    }
1727}
1728
1729/// An arrow binary array with i32 offsets
1730pub type BinaryType = GenericBinaryType<i32>;
1731/// An arrow binary array with i64 offsets
1732pub type LargeBinaryType = GenericBinaryType<i64>;
1733
1734mod byte_view {
1735    use crate::types::{BinaryViewType, StringViewType};
1736
1737    pub trait Sealed: Send + Sync {}
1738    impl Sealed for StringViewType {}
1739    impl Sealed for BinaryViewType {}
1740}
1741
1742/// A trait over the variable length bytes view array types
1743pub trait ByteViewType: byte_view::Sealed + 'static + PartialEq + Send + Sync {
1744    /// If element in array is utf8 encoded string.
1745    const IS_UTF8: bool;
1746
1747    /// Datatype of array elements
1748    const DATA_TYPE: DataType = if Self::IS_UTF8 {
1749        DataType::Utf8View
1750    } else {
1751        DataType::BinaryView
1752    };
1753
1754    /// "Binary" or "String", for use in displayed or error messages
1755    const PREFIX: &'static str;
1756
1757    /// Type for representing its equivalent rust type i.e
1758    /// Utf8Array will have native type has &str
1759    /// BinaryArray will have type as [u8]
1760    type Native: bytes::ByteArrayNativeType + AsRef<Self::Native> + AsRef<[u8]> + ?Sized;
1761
1762    /// Type for owned corresponding to `Native`
1763    type Owned: Debug + Clone + Sync + Send + AsRef<Self::Native>;
1764
1765    /// Verifies that the provided buffers are valid for this array type
1766    fn validate(views: &[u128], buffers: &[Buffer]) -> Result<(), ArrowError>;
1767}
1768
1769/// [`ByteViewType`] for string arrays
1770#[derive(PartialEq)]
1771pub struct StringViewType {}
1772
1773impl ByteViewType for StringViewType {
1774    const IS_UTF8: bool = true;
1775    const PREFIX: &'static str = "String";
1776
1777    type Native = str;
1778    type Owned = String;
1779
1780    fn validate(views: &[u128], buffers: &[Buffer]) -> Result<(), ArrowError> {
1781        validate_string_view(views, buffers)
1782    }
1783}
1784
1785/// [`BinaryViewType`] for string arrays
1786#[derive(PartialEq)]
1787pub struct BinaryViewType {}
1788
1789impl ByteViewType for BinaryViewType {
1790    const IS_UTF8: bool = false;
1791    const PREFIX: &'static str = "Binary";
1792    type Native = [u8];
1793    type Owned = Vec<u8>;
1794
1795    fn validate(views: &[u128], buffers: &[Buffer]) -> Result<(), ArrowError> {
1796        validate_binary_view(views, buffers)
1797    }
1798}
1799
1800#[cfg(test)]
1801mod tests {
1802    use super::*;
1803    use arrow_data::{BufferSpec, layout};
1804    use chrono::DateTime;
1805
1806    #[test]
1807    fn month_day_nano_should_roundtrip() {
1808        let value = IntervalMonthDayNanoType::make_value(1, 2, 3);
1809        assert_eq!(IntervalMonthDayNanoType::to_parts(value), (1, 2, 3));
1810    }
1811
1812    #[test]
1813    fn month_day_nano_should_roundtrip_neg() {
1814        let value = IntervalMonthDayNanoType::make_value(-1, -2, -3);
1815        assert_eq!(IntervalMonthDayNanoType::to_parts(value), (-1, -2, -3));
1816    }
1817
1818    #[test]
1819    fn day_time_should_roundtrip() {
1820        let value = IntervalDayTimeType::make_value(1, 2);
1821        assert_eq!(IntervalDayTimeType::to_parts(value), (1, 2));
1822    }
1823
1824    #[test]
1825    fn day_time_should_roundtrip_neg() {
1826        let value = IntervalDayTimeType::make_value(-1, -2);
1827        assert_eq!(IntervalDayTimeType::to_parts(value), (-1, -2));
1828    }
1829
1830    #[test]
1831    fn year_month_should_roundtrip() {
1832        let value = IntervalYearMonthType::make_value(1, 2);
1833        assert_eq!(IntervalYearMonthType::to_months(value), 14);
1834    }
1835
1836    #[test]
1837    fn year_month_should_roundtrip_neg() {
1838        let value = IntervalYearMonthType::make_value(-1, -2);
1839        assert_eq!(IntervalYearMonthType::to_months(value), -14);
1840    }
1841
1842    fn test_layout<T: ArrowPrimitiveType>() {
1843        let layout = layout(&T::DATA_TYPE);
1844
1845        assert_eq!(layout.buffers.len(), 1);
1846
1847        let spec = &layout.buffers[0];
1848        assert_eq!(
1849            spec,
1850            &BufferSpec::FixedWidth {
1851                byte_width: std::mem::size_of::<T::Native>(),
1852                alignment: std::mem::align_of::<T::Native>(),
1853            }
1854        );
1855    }
1856
1857    #[test]
1858    fn test_layouts() {
1859        test_layout::<Int8Type>();
1860        test_layout::<Int16Type>();
1861        test_layout::<Int32Type>();
1862        test_layout::<Int64Type>();
1863        test_layout::<UInt8Type>();
1864        test_layout::<UInt16Type>();
1865        test_layout::<UInt32Type>();
1866        test_layout::<UInt64Type>();
1867        test_layout::<Float16Type>();
1868        test_layout::<Float32Type>();
1869        test_layout::<Float64Type>();
1870        test_layout::<Decimal32Type>();
1871        test_layout::<Decimal64Type>();
1872        test_layout::<Decimal128Type>();
1873        test_layout::<Decimal256Type>();
1874        test_layout::<TimestampNanosecondType>();
1875        test_layout::<TimestampMillisecondType>();
1876        test_layout::<TimestampMicrosecondType>();
1877        test_layout::<TimestampNanosecondType>();
1878        test_layout::<TimestampSecondType>();
1879        test_layout::<Date32Type>();
1880        test_layout::<Date64Type>();
1881        test_layout::<Time32SecondType>();
1882        test_layout::<Time32MillisecondType>();
1883        test_layout::<Time64MicrosecondType>();
1884        test_layout::<Time64NanosecondType>();
1885        test_layout::<IntervalMonthDayNanoType>();
1886        test_layout::<IntervalDayTimeType>();
1887        test_layout::<IntervalYearMonthType>();
1888        test_layout::<DurationNanosecondType>();
1889        test_layout::<DurationMicrosecondType>();
1890        test_layout::<DurationMillisecondType>();
1891        test_layout::<DurationSecondType>();
1892    }
1893
1894    #[test]
1895    fn timestamp_from_datetime() {
1896        use chrono::{FixedOffset, NaiveDate, NaiveTime, Utc};
1897
1898        // Test UTC timezone
1899        let date = NaiveDate::from_ymd_opt(2021, 1, 1).unwrap();
1900        let time = NaiveTime::from_hms_opt(12, 0, 0).unwrap();
1901        let naive = NaiveDateTime::new(date, time);
1902        let datetime_utc = Utc.from_utc_datetime(&naive);
1903
1904        assert_eq!(
1905            TimestampSecondType::from_datetime(datetime_utc).unwrap(),
1906            1609502400
1907        );
1908        assert_eq!(
1909            TimestampMillisecondType::from_datetime(datetime_utc).unwrap(),
1910            1609502400000
1911        );
1912        assert_eq!(
1913            TimestampMicrosecondType::from_datetime(datetime_utc).unwrap(),
1914            1609502400000000
1915        );
1916        assert_eq!(
1917            TimestampNanosecondType::from_datetime(datetime_utc).unwrap(),
1918            1609502400000000000
1919        );
1920
1921        // Test FixedOffset timezone (+8:00): 12:00+8 = 04:00 UTC
1922        let tz_plus_8 = FixedOffset::east_opt(8 * 3600).unwrap();
1923        let datetime_plus_8 = tz_plus_8.from_local_datetime(&naive).unwrap();
1924        assert_eq!(
1925            TimestampSecondType::from_datetime(datetime_plus_8).unwrap(),
1926            1609502400 - 28800
1927        );
1928
1929        // Test subsecond precision
1930        let datetime = DateTime::from_timestamp(1000000000, 123456789).unwrap();
1931        assert_eq!(
1932            TimestampSecondType::from_datetime(datetime).unwrap(),
1933            1000000000
1934        );
1935        assert_eq!(
1936            TimestampMillisecondType::from_datetime(datetime).unwrap(),
1937            1000000000123
1938        );
1939        assert_eq!(
1940            TimestampMicrosecondType::from_datetime(datetime).unwrap(),
1941            1000000000123456
1942        );
1943        assert_eq!(
1944            TimestampNanosecondType::from_datetime(datetime).unwrap(),
1945            1000000000123456789
1946        );
1947    }
1948
1949    #[test]
1950    fn timestamp_from_datetime_overflow() {
1951        // Nanosecond precision has ~584 year range (1677-2262), easily overflows
1952        let far_past = DateTime::from_timestamp(-10_000_000_000, 0).unwrap();
1953        assert!(TimestampNanosecondType::from_datetime(far_past).is_none());
1954        // Other precisions should handle the same DateTime without overflow
1955        assert!(TimestampSecondType::from_datetime(far_past).is_some());
1956        assert!(TimestampMillisecondType::from_datetime(far_past).is_some());
1957        assert!(TimestampMicrosecondType::from_datetime(far_past).is_some());
1958
1959        let far_future = DateTime::from_timestamp(10_000_000_000, 0).unwrap();
1960        assert!(TimestampNanosecondType::from_datetime(far_future).is_none());
1961        assert!(TimestampSecondType::from_datetime(far_future).is_some());
1962        assert!(TimestampMillisecondType::from_datetime(far_future).is_some());
1963        assert!(TimestampMicrosecondType::from_datetime(far_future).is_some());
1964    }
1965
1966    #[test]
1967    fn timestamp_from_naive_datetime() {
1968        use crate::temporal_conversions::as_datetime_with_timezone;
1969        use chrono::{NaiveDate, NaiveTime};
1970
1971        let date = NaiveDate::from_ymd_opt(2021, 1, 1).unwrap();
1972        let time = NaiveTime::from_hms_opt(12, 0, 0).unwrap();
1973        let naive = NaiveDateTime::new(date, time);
1974
1975        // Test UTC (tz=None)
1976        assert_eq!(
1977            TimestampSecondType::from_naive_datetime(naive, None).unwrap(),
1978            1609502400
1979        );
1980        assert_eq!(
1981            TimestampMillisecondType::from_naive_datetime(naive, None).unwrap(),
1982            1609502400000
1983        );
1984
1985        // Test with timezone (-05:00): 12:00-5 = 17:00 UTC
1986        let tz: Tz = "-05:00".parse().unwrap();
1987        let ts_sec = TimestampSecondType::from_naive_datetime(naive, Some(&tz)).unwrap();
1988        assert_eq!(ts_sec, 1609502400 + 5 * 3600);
1989
1990        // Test all types with timezone and roundtrip
1991        let date = NaiveDate::from_ymd_opt(2024, 6, 15).unwrap();
1992        let time = NaiveTime::from_hms_opt(14, 30, 45).unwrap();
1993        let naive = NaiveDateTime::new(date, time);
1994        let tz: Tz = "+01:00".parse().unwrap();
1995
1996        let ts_usec = TimestampMicrosecondType::from_naive_datetime(naive, Some(&tz)).unwrap();
1997        let recovered = as_datetime_with_timezone::<TimestampMicrosecondType>(ts_usec, tz).unwrap();
1998        assert_eq!(recovered.naive_local(), naive);
1999    }
2000
2001    #[test]
2002    #[cfg(feature = "chrono-tz")]
2003    fn timestamp_from_naive_datetime_ambiguous() {
2004        use chrono::{NaiveDate, NaiveTime};
2005
2006        // 2024-11-03 01:30:00 in US Eastern Time is ambiguous (daylight saving time ends)
2007        // It can be either 01:30:00 EDT (UTC-4) or 01:30:00 EST (UTC-5)
2008        let date = NaiveDate::from_ymd_opt(2024, 11, 3).unwrap();
2009        let time = NaiveTime::from_hms_opt(1, 30, 0).unwrap();
2010        let naive = NaiveDateTime::new(date, time);
2011        let tz: Tz = "America/New_York".parse().unwrap();
2012
2013        // Should return the first/earlier time (EDT, UTC-4) = 05:30:00 UTC
2014        let result = TimestampSecondType::from_naive_datetime(naive, Some(&tz));
2015        assert!(result.is_some());
2016        assert_eq!(result.unwrap(), 1730611800);
2017    }
2018
2019    #[test]
2020    #[cfg(feature = "chrono-tz")]
2021    fn timestamp_from_naive_datetime_none() {
2022        use chrono::{NaiveDate, NaiveTime};
2023
2024        // 2024-03-10 02:30:00 in US Eastern Time doesn't exist
2025        // (daylight saving time starts at 02:00, jumps to 03:00)
2026        let date = NaiveDate::from_ymd_opt(2024, 3, 10).unwrap();
2027        let time = NaiveTime::from_hms_opt(2, 30, 0).unwrap();
2028        let naive = NaiveDateTime::new(date, time);
2029        let tz: Tz = "America/New_York".parse().unwrap();
2030
2031        // Should return None
2032        let result = TimestampSecondType::from_naive_datetime(naive, Some(&tz));
2033        assert!(result.is_none());
2034
2035        // Test for all timestamp types
2036        assert!(TimestampMillisecondType::from_naive_datetime(naive, Some(&tz)).is_none());
2037        assert!(TimestampMicrosecondType::from_naive_datetime(naive, Some(&tz)).is_none());
2038        assert!(TimestampNanosecondType::from_naive_datetime(naive, Some(&tz)).is_none());
2039    }
2040}