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    ///
949    /// # Panics
950    ///
951    /// Panics on overflow
952    #[deprecated(since = "58.0.0", note = "Use to_naive_date_opt instead.")]
953    pub fn to_naive_date(i: <Date32Type as ArrowPrimitiveType>::Native) -> NaiveDate {
954        Self::to_naive_date_opt(i)
955            .unwrap_or_else(|| panic!("Date32Type::to_naive_date overflowed for date: {i}"))
956    }
957
958    /// Converts an arrow Date32Type into a chrono::NaiveDate
959    ///
960    /// # Arguments
961    ///
962    /// * `i` - The Date32Type to convert
963    ///
964    /// Returns `Some(NaiveDate)` if it fits, `None` otherwise.
965    pub fn to_naive_date_opt(i: <Date32Type as ArrowPrimitiveType>::Native) -> Option<NaiveDate> {
966        let epoch = NaiveDate::default();
967        let d = Duration::try_days(i as i64)?;
968        epoch.checked_add_signed(d)
969    }
970
971    /// Converts a chrono::NaiveDate into an arrow Date32Type
972    ///
973    /// # Arguments
974    ///
975    /// * `d` - The NaiveDate to convert
976    pub fn from_naive_date(d: NaiveDate) -> <Date32Type as ArrowPrimitiveType>::Native {
977        let epoch = NaiveDate::default();
978        d.sub(epoch).num_days() as <Date32Type as ArrowPrimitiveType>::Native
979    }
980
981    /// Adds the given IntervalYearMonthType to an arrow Date32Type
982    ///
983    /// # Arguments
984    ///
985    /// * `date` - The date on which to perform the operation
986    /// * `delta` - The interval to add
987    ///
988    /// # Panics
989    ///
990    /// Panics on overflow
991    #[deprecated(
992        since = "58.0.0",
993        note = "Use `add_year_months_opt` instead, which returns an Option to handle overflow."
994    )]
995    pub fn add_year_months(
996        date: <Date32Type as ArrowPrimitiveType>::Native,
997        delta: <IntervalYearMonthType as ArrowPrimitiveType>::Native,
998    ) -> <Date32Type as ArrowPrimitiveType>::Native {
999        Self::add_year_months_opt(date, delta).unwrap_or_else(|| {
1000            panic!("Date32Type::add_year_months overflowed for date: {date}, delta: {delta}")
1001        })
1002    }
1003
1004    /// Adds the given IntervalYearMonthType to an arrow Date32Type
1005    ///
1006    /// # Arguments
1007    ///
1008    /// * `date` - The date on which to perform the operation
1009    /// * `delta` - The interval to add
1010    ///
1011    /// Returns `Some(Date32Type)` if it fits, `None` otherwise.
1012    pub fn add_year_months_opt(
1013        date: <Date32Type as ArrowPrimitiveType>::Native,
1014        delta: <IntervalYearMonthType as ArrowPrimitiveType>::Native,
1015    ) -> Option<<Date32Type as ArrowPrimitiveType>::Native> {
1016        let prior = Date32Type::to_naive_date_opt(date)?;
1017        let months = IntervalYearMonthType::to_months(delta);
1018        let posterior = add_months_date(prior, months)?;
1019        Some(Date32Type::from_naive_date(posterior))
1020    }
1021
1022    /// Adds the given IntervalDayTimeType to an arrow Date32Type
1023    ///
1024    /// # Arguments
1025    ///
1026    /// * `date` - The date on which to perform the operation
1027    /// * `delta` - The interval to add
1028    ///
1029    /// # Panics
1030    ///
1031    /// Panics on overflow
1032    #[deprecated(
1033        since = "58.0.0",
1034        note = "Use `add_day_time_opt` instead, which returns an Option to handle overflow."
1035    )]
1036    pub fn add_day_time(
1037        date: <Date32Type as ArrowPrimitiveType>::Native,
1038        delta: <IntervalDayTimeType as ArrowPrimitiveType>::Native,
1039    ) -> <Date32Type as ArrowPrimitiveType>::Native {
1040        Self::add_day_time_opt(date, delta).unwrap_or_else(|| {
1041            panic!("Date32Type::add_day_time overflowed for date: {date}, delta: {delta:?}")
1042        })
1043    }
1044
1045    /// Adds the given IntervalDayTimeType to an arrow Date32Type
1046    ///
1047    /// # Arguments
1048    ///
1049    /// * `date` - The date on which to perform the operation
1050    /// * `delta` - The interval to add
1051    ///
1052    /// Returns `Some(Date32Type)` if it fits, `None` otherwise.
1053    pub fn add_day_time_opt(
1054        date: <Date32Type as ArrowPrimitiveType>::Native,
1055        delta: <IntervalDayTimeType as ArrowPrimitiveType>::Native,
1056    ) -> Option<<Date32Type as ArrowPrimitiveType>::Native> {
1057        let (days, ms) = IntervalDayTimeType::to_parts(delta);
1058        let res = Date32Type::to_naive_date_opt(date)?;
1059        let res = res.checked_add_signed(Duration::try_days(days as i64)?)?;
1060        let res = res.checked_add_signed(Duration::try_milliseconds(ms as i64)?)?;
1061        Some(Date32Type::from_naive_date(res))
1062    }
1063
1064    /// Adds the given IntervalMonthDayNanoType to an arrow Date32Type
1065    ///
1066    /// # Arguments
1067    ///
1068    /// * `date` - The date on which to perform the operation
1069    /// * `delta` - The interval to add
1070    ///
1071    /// # Panics
1072    ///
1073    /// Panics on overflow
1074    #[deprecated(
1075        since = "58.0.0",
1076        note = "Use `add_month_day_nano_opt` instead, which returns an Option to handle overflow."
1077    )]
1078    pub fn add_month_day_nano(
1079        date: <Date32Type as ArrowPrimitiveType>::Native,
1080        delta: <IntervalMonthDayNanoType as ArrowPrimitiveType>::Native,
1081    ) -> <Date32Type as ArrowPrimitiveType>::Native {
1082        Self::add_month_day_nano_opt(date, delta).unwrap_or_else(|| {
1083            panic!("Date32Type::add_month_day_nano overflowed for date: {date}, delta: {delta:?}")
1084        })
1085    }
1086
1087    /// Adds the given IntervalMonthDayNanoType to an arrow Date32Type
1088    ///
1089    /// # Arguments
1090    ///
1091    /// * `date` - The date on which to perform the operation
1092    /// * `delta` - The interval to add
1093    ///
1094    /// Returns `Some(Date32Type)` if it fits, `None` otherwise.
1095    pub fn add_month_day_nano_opt(
1096        date: <Date32Type as ArrowPrimitiveType>::Native,
1097        delta: <IntervalMonthDayNanoType as ArrowPrimitiveType>::Native,
1098    ) -> Option<<Date32Type as ArrowPrimitiveType>::Native> {
1099        let (months, days, nanos) = IntervalMonthDayNanoType::to_parts(delta);
1100        let res = Date32Type::to_naive_date_opt(date)?;
1101        let res = add_months_date(res, months)?;
1102        let res = res.checked_add_signed(Duration::try_days(days as i64)?)?;
1103        let res = res.checked_add_signed(Duration::nanoseconds(nanos))?;
1104        Some(Date32Type::from_naive_date(res))
1105    }
1106
1107    /// Subtract the given IntervalYearMonthType to an arrow Date32Type
1108    ///
1109    /// # Arguments
1110    ///
1111    /// * `date` - The date on which to perform the operation
1112    /// * `delta` - The interval to subtract
1113    ///
1114    /// # Panics
1115    ///
1116    /// Panics on overflow
1117    #[deprecated(
1118        since = "58.0.0",
1119        note = "Use `subtract_year_months_opt` instead, which returns an Option to handle overflow."
1120    )]
1121    pub fn subtract_year_months(
1122        date: <Date32Type as ArrowPrimitiveType>::Native,
1123        delta: <IntervalYearMonthType as ArrowPrimitiveType>::Native,
1124    ) -> <Date32Type as ArrowPrimitiveType>::Native {
1125        Self::subtract_year_months_opt(date, delta).unwrap_or_else(|| {
1126            panic!("Date32Type::subtract_year_months overflowed for date: {date}, delta: {delta}")
1127        })
1128    }
1129
1130    /// Subtract the given IntervalYearMonthType to an arrow Date32Type
1131    ///
1132    /// # Arguments
1133    ///
1134    /// * `date` - The date on which to perform the operation
1135    /// * `delta` - The interval to subtract
1136    ///
1137    /// Returns `Some(Date32Type)` if it fits, `None` otherwise.
1138    pub fn subtract_year_months_opt(
1139        date: <Date32Type as ArrowPrimitiveType>::Native,
1140        delta: <IntervalYearMonthType as ArrowPrimitiveType>::Native,
1141    ) -> Option<<Date32Type as ArrowPrimitiveType>::Native> {
1142        let prior = Date32Type::to_naive_date_opt(date)?;
1143        let months = IntervalYearMonthType::to_months(-delta);
1144        let posterior = add_months_date(prior, months)?;
1145        Some(Date32Type::from_naive_date(posterior))
1146    }
1147
1148    /// Subtract the given IntervalDayTimeType to an arrow Date32Type
1149    ///
1150    /// # Arguments
1151    ///
1152    /// * `date` - The date on which to perform the operation
1153    /// * `delta` - The interval to subtract
1154    ///
1155    /// # Panics
1156    ///
1157    /// Panics on overflow
1158    #[deprecated(
1159        since = "58.0.0",
1160        note = "Use `subtract_day_time_opt` instead, which returns an Option to handle overflow."
1161    )]
1162    pub fn subtract_day_time(
1163        date: <Date32Type as ArrowPrimitiveType>::Native,
1164        delta: <IntervalDayTimeType as ArrowPrimitiveType>::Native,
1165    ) -> <Date32Type as ArrowPrimitiveType>::Native {
1166        Self::subtract_day_time_opt(date, delta).unwrap_or_else(|| {
1167            panic!("Date32Type::subtract_day_time overflowed for date: {date}, delta: {delta:?}")
1168        })
1169    }
1170
1171    /// Subtract the given IntervalDayTimeType to an arrow Date32Type
1172    ///
1173    /// # Arguments
1174    ///
1175    /// * `date` - The date on which to perform the operation
1176    /// * `delta` - The interval to subtract
1177    ///
1178    /// Returns `Some(Date32Type)` if it fits, `None` otherwise.
1179    pub fn subtract_day_time_opt(
1180        date: <Date32Type as ArrowPrimitiveType>::Native,
1181        delta: <IntervalDayTimeType as ArrowPrimitiveType>::Native,
1182    ) -> Option<<Date32Type as ArrowPrimitiveType>::Native> {
1183        let (days, ms) = IntervalDayTimeType::to_parts(delta);
1184        let res = Date32Type::to_naive_date_opt(date)?;
1185        let res = res.checked_sub_signed(Duration::try_days(days as i64)?)?;
1186        let res = res.checked_sub_signed(Duration::try_milliseconds(ms as i64)?)?;
1187        Some(Date32Type::from_naive_date(res))
1188    }
1189
1190    /// Subtract the given IntervalMonthDayNanoType to an arrow Date32Type
1191    ///
1192    /// # Arguments
1193    ///
1194    /// * `date` - The date on which to perform the operation
1195    /// * `delta` - The interval to subtract
1196    ///
1197    /// # Panics
1198    ///
1199    /// Panics on overflow
1200    #[deprecated(
1201        since = "58.0.0",
1202        note = "Use `subtract_month_day_nano_opt` instead, which returns an Option to handle overflow."
1203    )]
1204    pub fn subtract_month_day_nano(
1205        date: <Date32Type as ArrowPrimitiveType>::Native,
1206        delta: <IntervalMonthDayNanoType as ArrowPrimitiveType>::Native,
1207    ) -> <Date32Type as ArrowPrimitiveType>::Native {
1208        Self::subtract_month_day_nano_opt(date, delta).unwrap_or_else(|| {
1209            panic!(
1210                "Date32Type::subtract_month_day_nano overflowed for date: {date}, delta: {delta:?}",
1211            )
1212        })
1213    }
1214
1215    /// Subtract the given IntervalMonthDayNanoType to an arrow Date32Type
1216    ///
1217    /// # Arguments
1218    ///
1219    /// * `date` - The date on which to perform the operation
1220    /// * `delta` - The interval to subtract
1221    ///
1222    /// Returns `Some(Date32Type)` if it fits, `None` otherwise.
1223    pub fn subtract_month_day_nano_opt(
1224        date: <Date32Type as ArrowPrimitiveType>::Native,
1225        delta: <IntervalMonthDayNanoType as ArrowPrimitiveType>::Native,
1226    ) -> Option<<Date32Type as ArrowPrimitiveType>::Native> {
1227        let (months, days, nanos) = IntervalMonthDayNanoType::to_parts(delta);
1228        let res = Date32Type::to_naive_date_opt(date)?;
1229        let res = add_months_date(res, -months)?;
1230        let res = res.checked_sub_signed(Duration::try_days(days as i64)?)?;
1231        let res = res.checked_sub_signed(Duration::nanoseconds(nanos))?;
1232        Some(Date32Type::from_naive_date(res))
1233    }
1234}
1235
1236impl Date64Type {
1237    /// Converts an arrow Date64Type into a chrono::NaiveDateTime if it fits in the range that chrono::NaiveDateTime can represent.
1238    /// Returns `None` if the calculation would overflow or underflow.
1239    ///
1240    /// 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).
1241    ///
1242    /// # Arguments
1243    ///
1244    /// * `i` - The Date64Type to convert
1245    ///
1246    /// Returns `Some(NaiveDateTime)` if it fits, `None` otherwise.
1247    pub fn to_naive_date_opt(i: <Date64Type as ArrowPrimitiveType>::Native) -> Option<NaiveDate> {
1248        let epoch = NaiveDate::default();
1249        let d = Duration::try_milliseconds(i)?;
1250        epoch.checked_add_signed(d)
1251    }
1252
1253    /// Converts a chrono::NaiveDate into an arrow Date64Type
1254    ///
1255    /// # Arguments
1256    ///
1257    /// * `d` - The NaiveDate to convert
1258    pub fn from_naive_date(d: NaiveDate) -> <Date64Type as ArrowPrimitiveType>::Native {
1259        let epoch = NaiveDate::default();
1260        d.sub(epoch).num_milliseconds()
1261    }
1262
1263    /// Adds the given IntervalYearMonthType to an arrow Date64Type
1264    ///
1265    /// # Arguments
1266    ///
1267    /// * `date` - The date on which to perform the operation
1268    /// * `delta` - The interval to add
1269    ///
1270    /// Returns `Some(Date64Type)` if it fits, `None` otherwise.
1271    pub fn add_year_months_opt(
1272        date: <Date64Type as ArrowPrimitiveType>::Native,
1273        delta: <IntervalYearMonthType as ArrowPrimitiveType>::Native,
1274    ) -> Option<<Date64Type as ArrowPrimitiveType>::Native> {
1275        let prior = Date64Type::to_naive_date_opt(date)?;
1276        let months = IntervalYearMonthType::to_months(delta);
1277        let posterior = add_months_date(prior, months)?;
1278        Some(Date64Type::from_naive_date(posterior))
1279    }
1280
1281    /// Adds the given IntervalDayTimeType to an arrow Date64Type
1282    ///
1283    /// # Arguments
1284    ///
1285    /// * `date` - The date on which to perform the operation
1286    /// * `delta` - The interval to add
1287    ///
1288    /// Returns `Some(Date64Type)` if it fits, `None` otherwise.
1289    pub fn add_day_time_opt(
1290        date: <Date64Type as ArrowPrimitiveType>::Native,
1291        delta: <IntervalDayTimeType as ArrowPrimitiveType>::Native,
1292    ) -> Option<<Date64Type as ArrowPrimitiveType>::Native> {
1293        let (days, ms) = IntervalDayTimeType::to_parts(delta);
1294        let res = Date64Type::to_naive_date_opt(date)?;
1295        let res = res.checked_add_signed(Duration::try_days(days as i64)?)?;
1296        let res = res.checked_add_signed(Duration::try_milliseconds(ms as i64)?)?;
1297        Some(Date64Type::from_naive_date(res))
1298    }
1299
1300    /// Adds the given IntervalMonthDayNanoType to an arrow Date64Type
1301    ///
1302    /// # Arguments
1303    ///
1304    /// * `date` - The date on which to perform the operation
1305    /// * `delta` - The interval to add
1306    ///
1307    /// Returns `Some(Date64Type)` if it fits, `None` otherwise.
1308    pub fn add_month_day_nano_opt(
1309        date: <Date64Type as ArrowPrimitiveType>::Native,
1310        delta: <IntervalMonthDayNanoType as ArrowPrimitiveType>::Native,
1311    ) -> Option<<Date64Type as ArrowPrimitiveType>::Native> {
1312        let (months, days, nanos) = IntervalMonthDayNanoType::to_parts(delta);
1313        let res = Date64Type::to_naive_date_opt(date)?;
1314        let res = add_months_date(res, months)?;
1315        let res = res.checked_add_signed(Duration::try_days(days as i64)?)?;
1316        let res = res.checked_add_signed(Duration::nanoseconds(nanos))?;
1317        Some(Date64Type::from_naive_date(res))
1318    }
1319
1320    /// Subtract the given IntervalYearMonthType to an arrow Date64Type
1321    ///
1322    /// # Arguments
1323    ///
1324    /// * `date` - The date on which to perform the operation
1325    /// * `delta` - The interval to subtract
1326    ///
1327    /// Returns `Some(Date64Type)` if it fits, `None` otherwise.
1328    pub fn subtract_year_months_opt(
1329        date: <Date64Type as ArrowPrimitiveType>::Native,
1330        delta: <IntervalYearMonthType as ArrowPrimitiveType>::Native,
1331    ) -> Option<<Date64Type as ArrowPrimitiveType>::Native> {
1332        let prior = Date64Type::to_naive_date_opt(date)?;
1333        let months = IntervalYearMonthType::to_months(-delta);
1334        let posterior = add_months_date(prior, months)?;
1335        Some(Date64Type::from_naive_date(posterior))
1336    }
1337
1338    /// Subtract the given IntervalDayTimeType to an arrow Date64Type
1339    ///
1340    /// # Arguments
1341    ///
1342    /// * `date` - The date on which to perform the operation
1343    /// * `delta` - The interval to subtract
1344    ///
1345    /// Returns `Some(Date64Type)` if it fits, `None` otherwise.
1346    pub fn subtract_day_time_opt(
1347        date: <Date64Type as ArrowPrimitiveType>::Native,
1348        delta: <IntervalDayTimeType as ArrowPrimitiveType>::Native,
1349    ) -> Option<<Date64Type as ArrowPrimitiveType>::Native> {
1350        let (days, ms) = IntervalDayTimeType::to_parts(delta);
1351        let res = Date64Type::to_naive_date_opt(date)?;
1352        let res = res.checked_sub_signed(Duration::try_days(days as i64)?)?;
1353        let res = res.checked_sub_signed(Duration::try_milliseconds(ms as i64)?)?;
1354        Some(Date64Type::from_naive_date(res))
1355    }
1356
1357    /// Subtract the given IntervalMonthDayNanoType to an arrow Date64Type
1358    ///
1359    /// # Arguments
1360    ///
1361    /// * `date` - The date on which to perform the operation
1362    /// * `delta` - The interval to subtract
1363    ///
1364    /// Returns `Some(Date64Type)` if it fits, `None` otherwise.
1365    pub fn subtract_month_day_nano_opt(
1366        date: <Date64Type as ArrowPrimitiveType>::Native,
1367        delta: <IntervalMonthDayNanoType as ArrowPrimitiveType>::Native,
1368    ) -> Option<<Date64Type as ArrowPrimitiveType>::Native> {
1369        let (months, days, nanos) = IntervalMonthDayNanoType::to_parts(delta);
1370        let res = Date64Type::to_naive_date_opt(date)?;
1371        let res = add_months_date(res, -months)?;
1372        let res = res.checked_sub_signed(Duration::try_days(days as i64)?)?;
1373        let res = res.checked_sub_signed(Duration::nanoseconds(nanos))?;
1374        Some(Date64Type::from_naive_date(res))
1375    }
1376}
1377
1378/// Crate private types for Decimal Arrays
1379///
1380/// Not intended to be used outside this crate
1381mod decimal {
1382    use super::*;
1383
1384    pub trait DecimalTypeSealed {}
1385    impl DecimalTypeSealed for Decimal32Type {}
1386    impl DecimalTypeSealed for Decimal64Type {}
1387    impl DecimalTypeSealed for Decimal128Type {}
1388    impl DecimalTypeSealed for Decimal256Type {}
1389}
1390
1391/// A trait over the decimal types, used by [`PrimitiveArray`] to provide a generic
1392/// implementation across the various decimal types
1393///
1394/// Implemented by [`Decimal32Type`], [`Decimal64Type`], [`Decimal128Type`] and [`Decimal256Type`]
1395/// for [`Decimal32Array`], [`Decimal64Array`], [`Decimal128Array`] and [`Decimal256Array`] respectively
1396///
1397/// [`PrimitiveArray`]: crate::array::PrimitiveArray
1398/// [`Decimal32Array`]: crate::array::Decimal32Array
1399/// [`Decimal64Array`]: crate::array::Decimal64Array
1400/// [`Decimal128Array`]: crate::array::Decimal128Array
1401/// [`Decimal256Array`]: crate::array::Decimal256Array
1402pub trait DecimalType:
1403    'static + Send + Sync + ArrowPrimitiveType + decimal::DecimalTypeSealed
1404{
1405    /// Width of the type
1406    const BYTE_LENGTH: usize;
1407    /// Maximum number of significant digits
1408    const MAX_PRECISION: u8;
1409    /// Maximum no of digits after the decimal point (note the scale can be negative)
1410    const MAX_SCALE: i8;
1411    /// The maximum value for each precision in `0..=MAX_PRECISION`: [0, 9, 99, ...]
1412    const MAX_FOR_EACH_PRECISION: &'static [Self::Native];
1413    /// fn to create its [`DataType`]
1414    const TYPE_CONSTRUCTOR: fn(u8, i8) -> DataType;
1415    /// Default values for [`DataType`]
1416    const DEFAULT_TYPE: DataType;
1417
1418    /// "Decimal32", "Decimal64", "Decimal128" or "Decimal256", for use in error messages
1419    const PREFIX: &'static str;
1420
1421    /// Formats the decimal value with the provided precision and scale
1422    fn format_decimal(value: Self::Native, precision: u8, scale: i8) -> String;
1423
1424    /// Validates that `value` contains no more than `precision` decimal digits
1425    fn validate_decimal_precision(
1426        value: Self::Native,
1427        precision: u8,
1428        scale: i8,
1429    ) -> Result<(), ArrowError>;
1430
1431    /// Determines whether `value` contains no more than `precision` decimal digits
1432    fn is_valid_decimal_precision(value: Self::Native, precision: u8) -> bool;
1433}
1434
1435/// Validate that `precision` and `scale` are valid for `T`
1436///
1437/// Returns an Error if:
1438/// - `precision` is zero
1439/// - `precision` is larger than `T:MAX_PRECISION`
1440/// - `scale` is larger than `T::MAX_SCALE`
1441/// - `scale` is > `precision`
1442pub fn validate_decimal_precision_and_scale<T: DecimalType>(
1443    precision: u8,
1444    scale: i8,
1445) -> Result<(), ArrowError> {
1446    if precision == 0 {
1447        return Err(ArrowError::InvalidArgumentError(format!(
1448            "precision cannot be 0, has to be between [1, {}]",
1449            T::MAX_PRECISION
1450        )));
1451    }
1452    if precision > T::MAX_PRECISION {
1453        return Err(ArrowError::InvalidArgumentError(format!(
1454            "precision {} is greater than max {}",
1455            precision,
1456            T::MAX_PRECISION
1457        )));
1458    }
1459    if scale > T::MAX_SCALE {
1460        return Err(ArrowError::InvalidArgumentError(format!(
1461            "scale {} is greater than max {}",
1462            scale,
1463            T::MAX_SCALE
1464        )));
1465    }
1466    if scale > 0 && scale as u8 > precision {
1467        return Err(ArrowError::InvalidArgumentError(format!(
1468            "scale {scale} is greater than precision {precision}"
1469        )));
1470    }
1471
1472    Ok(())
1473}
1474
1475/// The decimal type for a Decimal32Array
1476#[derive(Debug)]
1477pub struct Decimal32Type {}
1478
1479impl DecimalType for Decimal32Type {
1480    const BYTE_LENGTH: usize = 4;
1481    const MAX_PRECISION: u8 = DECIMAL32_MAX_PRECISION;
1482    const MAX_SCALE: i8 = DECIMAL32_MAX_SCALE;
1483    const MAX_FOR_EACH_PRECISION: &'static [i32] =
1484        &arrow_data::decimal::MAX_DECIMAL32_FOR_EACH_PRECISION;
1485    const TYPE_CONSTRUCTOR: fn(u8, i8) -> DataType = DataType::Decimal32;
1486    const DEFAULT_TYPE: DataType =
1487        DataType::Decimal32(DECIMAL32_MAX_PRECISION, DECIMAL32_DEFAULT_SCALE);
1488    const PREFIX: &'static str = "Decimal32";
1489
1490    fn format_decimal(value: Self::Native, precision: u8, scale: i8) -> String {
1491        format_decimal_str(&value.to_string(), precision as usize, scale)
1492    }
1493
1494    fn validate_decimal_precision(num: i32, precision: u8, scale: i8) -> Result<(), ArrowError> {
1495        validate_decimal32_precision(num, precision, scale)
1496    }
1497
1498    fn is_valid_decimal_precision(value: Self::Native, precision: u8) -> bool {
1499        is_validate_decimal32_precision(value, precision)
1500    }
1501}
1502
1503impl ArrowPrimitiveType for Decimal32Type {
1504    type Native = i32;
1505
1506    const DATA_TYPE: DataType = <Self as DecimalType>::DEFAULT_TYPE;
1507}
1508
1509impl primitive::PrimitiveTypeSealed for Decimal32Type {}
1510
1511/// The decimal type for a Decimal64Array
1512#[derive(Debug)]
1513pub struct Decimal64Type {}
1514
1515impl DecimalType for Decimal64Type {
1516    const BYTE_LENGTH: usize = 8;
1517    const MAX_PRECISION: u8 = DECIMAL64_MAX_PRECISION;
1518    const MAX_SCALE: i8 = DECIMAL64_MAX_SCALE;
1519    const MAX_FOR_EACH_PRECISION: &'static [i64] =
1520        &arrow_data::decimal::MAX_DECIMAL64_FOR_EACH_PRECISION;
1521    const TYPE_CONSTRUCTOR: fn(u8, i8) -> DataType = DataType::Decimal64;
1522    const DEFAULT_TYPE: DataType =
1523        DataType::Decimal64(DECIMAL64_MAX_PRECISION, DECIMAL64_DEFAULT_SCALE);
1524    const PREFIX: &'static str = "Decimal64";
1525
1526    fn format_decimal(value: Self::Native, precision: u8, scale: i8) -> String {
1527        format_decimal_str(&value.to_string(), precision as usize, scale)
1528    }
1529
1530    fn validate_decimal_precision(num: i64, precision: u8, scale: i8) -> Result<(), ArrowError> {
1531        validate_decimal64_precision(num, precision, scale)
1532    }
1533
1534    fn is_valid_decimal_precision(value: Self::Native, precision: u8) -> bool {
1535        is_validate_decimal64_precision(value, precision)
1536    }
1537}
1538
1539impl ArrowPrimitiveType for Decimal64Type {
1540    type Native = i64;
1541
1542    const DATA_TYPE: DataType = <Self as DecimalType>::DEFAULT_TYPE;
1543}
1544
1545impl primitive::PrimitiveTypeSealed for Decimal64Type {}
1546
1547/// The decimal type for a Decimal128Array
1548#[derive(Debug)]
1549pub struct Decimal128Type {}
1550
1551impl DecimalType for Decimal128Type {
1552    const BYTE_LENGTH: usize = 16;
1553    const MAX_PRECISION: u8 = DECIMAL128_MAX_PRECISION;
1554    const MAX_SCALE: i8 = DECIMAL128_MAX_SCALE;
1555    const MAX_FOR_EACH_PRECISION: &'static [i128] =
1556        &arrow_data::decimal::MAX_DECIMAL128_FOR_EACH_PRECISION;
1557    const TYPE_CONSTRUCTOR: fn(u8, i8) -> DataType = DataType::Decimal128;
1558    const DEFAULT_TYPE: DataType =
1559        DataType::Decimal128(DECIMAL128_MAX_PRECISION, DECIMAL_DEFAULT_SCALE);
1560    const PREFIX: &'static str = "Decimal128";
1561
1562    fn format_decimal(value: Self::Native, precision: u8, scale: i8) -> String {
1563        format_decimal_str(&value.to_string(), precision as usize, scale)
1564    }
1565
1566    fn validate_decimal_precision(num: i128, precision: u8, scale: i8) -> Result<(), ArrowError> {
1567        validate_decimal_precision(num, precision, scale)
1568    }
1569
1570    fn is_valid_decimal_precision(value: Self::Native, precision: u8) -> bool {
1571        is_validate_decimal_precision(value, precision)
1572    }
1573}
1574
1575impl ArrowPrimitiveType for Decimal128Type {
1576    type Native = i128;
1577
1578    const DATA_TYPE: DataType = <Self as DecimalType>::DEFAULT_TYPE;
1579}
1580
1581impl primitive::PrimitiveTypeSealed for Decimal128Type {}
1582
1583/// The decimal type for a Decimal256Array
1584#[derive(Debug)]
1585pub struct Decimal256Type {}
1586
1587impl DecimalType for Decimal256Type {
1588    const BYTE_LENGTH: usize = 32;
1589    const MAX_PRECISION: u8 = DECIMAL256_MAX_PRECISION;
1590    const MAX_SCALE: i8 = DECIMAL256_MAX_SCALE;
1591    const MAX_FOR_EACH_PRECISION: &'static [i256] =
1592        &arrow_data::decimal::MAX_DECIMAL256_FOR_EACH_PRECISION;
1593    const TYPE_CONSTRUCTOR: fn(u8, i8) -> DataType = DataType::Decimal256;
1594    const DEFAULT_TYPE: DataType =
1595        DataType::Decimal256(DECIMAL256_MAX_PRECISION, DECIMAL_DEFAULT_SCALE);
1596    const PREFIX: &'static str = "Decimal256";
1597
1598    fn format_decimal(value: Self::Native, precision: u8, scale: i8) -> String {
1599        format_decimal_str(&value.to_string(), precision as usize, scale)
1600    }
1601
1602    fn validate_decimal_precision(num: i256, precision: u8, scale: i8) -> Result<(), ArrowError> {
1603        validate_decimal256_precision(num, precision, scale)
1604    }
1605
1606    fn is_valid_decimal_precision(value: Self::Native, precision: u8) -> bool {
1607        is_validate_decimal256_precision(value, precision)
1608    }
1609}
1610
1611impl ArrowPrimitiveType for Decimal256Type {
1612    type Native = i256;
1613
1614    const DATA_TYPE: DataType = <Self as DecimalType>::DEFAULT_TYPE;
1615}
1616
1617impl primitive::PrimitiveTypeSealed for Decimal256Type {}
1618
1619/// Crate private types for Byte Arrays
1620///
1621/// Not intended to be used outside this crate
1622pub(crate) mod bytes {
1623    use super::*;
1624
1625    pub trait ByteArrayTypeSealed {}
1626    impl<O: OffsetSizeTrait> ByteArrayTypeSealed for GenericStringType<O> {}
1627    impl<O: OffsetSizeTrait> ByteArrayTypeSealed for GenericBinaryType<O> {}
1628
1629    pub trait ByteArrayNativeType: std::fmt::Debug + Send + Sync {
1630        fn from_bytes_checked(b: &[u8]) -> Option<&Self>;
1631
1632        /// # Safety
1633        ///
1634        /// `b` must be a valid byte sequence for `Self`
1635        unsafe fn from_bytes_unchecked(b: &[u8]) -> &Self;
1636    }
1637
1638    impl ByteArrayNativeType for [u8] {
1639        #[inline]
1640        fn from_bytes_checked(b: &[u8]) -> Option<&Self> {
1641            Some(b)
1642        }
1643
1644        #[inline]
1645        unsafe fn from_bytes_unchecked(b: &[u8]) -> &Self {
1646            b
1647        }
1648    }
1649
1650    impl ByteArrayNativeType for str {
1651        #[inline]
1652        fn from_bytes_checked(b: &[u8]) -> Option<&Self> {
1653            std::str::from_utf8(b).ok()
1654        }
1655
1656        #[inline]
1657        unsafe fn from_bytes_unchecked(b: &[u8]) -> &Self {
1658            unsafe { std::str::from_utf8_unchecked(b) }
1659        }
1660    }
1661}
1662
1663/// A trait over the variable-size byte array types
1664///
1665/// See [Variable Size Binary Layout](https://arrow.apache.org/docs/format/Columnar.html#variable-size-binary-layout)
1666pub trait ByteArrayType: 'static + Send + Sync + bytes::ByteArrayTypeSealed {
1667    /// Type of offset i.e i32/i64
1668    type Offset: OffsetSizeTrait;
1669    /// Type for representing its equivalent rust type i.e
1670    /// Utf8Array will have native type has &str
1671    /// BinaryArray will have type as [u8]
1672    type Native: bytes::ByteArrayNativeType + AsRef<Self::Native> + AsRef<[u8]> + ?Sized;
1673
1674    /// "Binary" or "String", for use in error messages
1675    const PREFIX: &'static str;
1676
1677    /// Datatype of array elements
1678    const DATA_TYPE: DataType;
1679
1680    /// Verifies that every consecutive pair of `offsets` denotes a valid slice of `values`
1681    fn validate(offsets: &OffsetBuffer<Self::Offset>, values: &Buffer) -> Result<(), ArrowError>;
1682}
1683
1684/// [`ByteArrayType`] for string arrays
1685pub struct GenericStringType<O: OffsetSizeTrait> {
1686    phantom: PhantomData<O>,
1687}
1688
1689impl<O: OffsetSizeTrait> ByteArrayType for GenericStringType<O> {
1690    type Offset = O;
1691    type Native = str;
1692    const PREFIX: &'static str = "String";
1693
1694    const DATA_TYPE: DataType = if O::IS_LARGE {
1695        DataType::LargeUtf8
1696    } else {
1697        DataType::Utf8
1698    };
1699
1700    fn validate(offsets: &OffsetBuffer<Self::Offset>, values: &Buffer) -> Result<(), ArrowError> {
1701        // Verify that the slice as a whole is valid UTF-8
1702        let validated = std::str::from_utf8(values).map_err(|e| {
1703            ArrowError::InvalidArgumentError(format!("Encountered non UTF-8 data: {e}"))
1704        })?;
1705
1706        // Verify each offset is at a valid character boundary in this UTF-8 array
1707        for offset in offsets.iter() {
1708            let o = offset.as_usize();
1709            if !validated.is_char_boundary(o) {
1710                if o < validated.len() {
1711                    return Err(ArrowError::InvalidArgumentError(format!(
1712                        "Split UTF-8 codepoint at offset {o}"
1713                    )));
1714                }
1715                return Err(ArrowError::InvalidArgumentError(format!(
1716                    "Offset of {o} exceeds length of values {}",
1717                    validated.len()
1718                )));
1719            }
1720        }
1721        Ok(())
1722    }
1723}
1724
1725/// An arrow utf8 array with i32 offsets
1726pub type Utf8Type = GenericStringType<i32>;
1727/// An arrow utf8 array with i64 offsets
1728pub type LargeUtf8Type = GenericStringType<i64>;
1729
1730/// [`ByteArrayType`] for binary arrays
1731pub struct GenericBinaryType<O: OffsetSizeTrait> {
1732    phantom: PhantomData<O>,
1733}
1734
1735impl<O: OffsetSizeTrait> ByteArrayType for GenericBinaryType<O> {
1736    type Offset = O;
1737    type Native = [u8];
1738    const PREFIX: &'static str = "Binary";
1739
1740    const DATA_TYPE: DataType = if O::IS_LARGE {
1741        DataType::LargeBinary
1742    } else {
1743        DataType::Binary
1744    };
1745
1746    fn validate(offsets: &OffsetBuffer<Self::Offset>, values: &Buffer) -> Result<(), ArrowError> {
1747        // offsets are guaranteed to be monotonically increasing and non-empty
1748        let max_offset = offsets.last().as_usize();
1749        if values.len() < max_offset {
1750            return Err(ArrowError::InvalidArgumentError(format!(
1751                "Maximum offset of {max_offset} is larger than values of length {}",
1752                values.len()
1753            )));
1754        }
1755        Ok(())
1756    }
1757}
1758
1759/// An arrow binary array with i32 offsets
1760pub type BinaryType = GenericBinaryType<i32>;
1761/// An arrow binary array with i64 offsets
1762pub type LargeBinaryType = GenericBinaryType<i64>;
1763
1764mod byte_view {
1765    use crate::types::{BinaryViewType, StringViewType};
1766
1767    pub trait Sealed: Send + Sync {}
1768    impl Sealed for StringViewType {}
1769    impl Sealed for BinaryViewType {}
1770}
1771
1772/// A trait over the variable length bytes view array types
1773pub trait ByteViewType: byte_view::Sealed + 'static + PartialEq + Send + Sync {
1774    /// If element in array is utf8 encoded string.
1775    const IS_UTF8: bool;
1776
1777    /// Datatype of array elements
1778    const DATA_TYPE: DataType = if Self::IS_UTF8 {
1779        DataType::Utf8View
1780    } else {
1781        DataType::BinaryView
1782    };
1783
1784    /// "Binary" or "String", for use in displayed or error messages
1785    const PREFIX: &'static str;
1786
1787    /// Type for representing its equivalent rust type i.e
1788    /// Utf8Array will have native type has &str
1789    /// BinaryArray will have type as [u8]
1790    type Native: bytes::ByteArrayNativeType + AsRef<Self::Native> + AsRef<[u8]> + ?Sized;
1791
1792    /// Type for owned corresponding to `Native`
1793    type Owned: Debug + Clone + Sync + Send + AsRef<Self::Native>;
1794
1795    /// Verifies that the provided buffers are valid for this array type
1796    fn validate(views: &[u128], buffers: &[Buffer]) -> Result<(), ArrowError>;
1797}
1798
1799/// [`ByteViewType`] for string arrays
1800#[derive(PartialEq)]
1801pub struct StringViewType {}
1802
1803impl ByteViewType for StringViewType {
1804    const IS_UTF8: bool = true;
1805    const PREFIX: &'static str = "String";
1806
1807    type Native = str;
1808    type Owned = String;
1809
1810    fn validate(views: &[u128], buffers: &[Buffer]) -> Result<(), ArrowError> {
1811        validate_string_view(views, buffers)
1812    }
1813}
1814
1815/// [`BinaryViewType`] for string arrays
1816#[derive(PartialEq)]
1817pub struct BinaryViewType {}
1818
1819impl ByteViewType for BinaryViewType {
1820    const IS_UTF8: bool = false;
1821    const PREFIX: &'static str = "Binary";
1822    type Native = [u8];
1823    type Owned = Vec<u8>;
1824
1825    fn validate(views: &[u128], buffers: &[Buffer]) -> Result<(), ArrowError> {
1826        validate_binary_view(views, buffers)
1827    }
1828}
1829
1830#[cfg(test)]
1831mod tests {
1832    use super::*;
1833    use arrow_data::{BufferSpec, layout};
1834    use chrono::DateTime;
1835
1836    #[test]
1837    fn month_day_nano_should_roundtrip() {
1838        let value = IntervalMonthDayNanoType::make_value(1, 2, 3);
1839        assert_eq!(IntervalMonthDayNanoType::to_parts(value), (1, 2, 3));
1840    }
1841
1842    #[test]
1843    fn month_day_nano_should_roundtrip_neg() {
1844        let value = IntervalMonthDayNanoType::make_value(-1, -2, -3);
1845        assert_eq!(IntervalMonthDayNanoType::to_parts(value), (-1, -2, -3));
1846    }
1847
1848    #[test]
1849    fn day_time_should_roundtrip() {
1850        let value = IntervalDayTimeType::make_value(1, 2);
1851        assert_eq!(IntervalDayTimeType::to_parts(value), (1, 2));
1852    }
1853
1854    #[test]
1855    fn day_time_should_roundtrip_neg() {
1856        let value = IntervalDayTimeType::make_value(-1, -2);
1857        assert_eq!(IntervalDayTimeType::to_parts(value), (-1, -2));
1858    }
1859
1860    #[test]
1861    fn year_month_should_roundtrip() {
1862        let value = IntervalYearMonthType::make_value(1, 2);
1863        assert_eq!(IntervalYearMonthType::to_months(value), 14);
1864    }
1865
1866    #[test]
1867    fn year_month_should_roundtrip_neg() {
1868        let value = IntervalYearMonthType::make_value(-1, -2);
1869        assert_eq!(IntervalYearMonthType::to_months(value), -14);
1870    }
1871
1872    fn test_layout<T: ArrowPrimitiveType>() {
1873        let layout = layout(&T::DATA_TYPE);
1874
1875        assert_eq!(layout.buffers.len(), 1);
1876
1877        let spec = &layout.buffers[0];
1878        assert_eq!(
1879            spec,
1880            &BufferSpec::FixedWidth {
1881                byte_width: std::mem::size_of::<T::Native>(),
1882                alignment: std::mem::align_of::<T::Native>(),
1883            }
1884        );
1885    }
1886
1887    #[test]
1888    fn test_layouts() {
1889        test_layout::<Int8Type>();
1890        test_layout::<Int16Type>();
1891        test_layout::<Int32Type>();
1892        test_layout::<Int64Type>();
1893        test_layout::<UInt8Type>();
1894        test_layout::<UInt16Type>();
1895        test_layout::<UInt32Type>();
1896        test_layout::<UInt64Type>();
1897        test_layout::<Float16Type>();
1898        test_layout::<Float32Type>();
1899        test_layout::<Float64Type>();
1900        test_layout::<Decimal32Type>();
1901        test_layout::<Decimal64Type>();
1902        test_layout::<Decimal128Type>();
1903        test_layout::<Decimal256Type>();
1904        test_layout::<TimestampNanosecondType>();
1905        test_layout::<TimestampMillisecondType>();
1906        test_layout::<TimestampMicrosecondType>();
1907        test_layout::<TimestampNanosecondType>();
1908        test_layout::<TimestampSecondType>();
1909        test_layout::<Date32Type>();
1910        test_layout::<Date64Type>();
1911        test_layout::<Time32SecondType>();
1912        test_layout::<Time32MillisecondType>();
1913        test_layout::<Time64MicrosecondType>();
1914        test_layout::<Time64NanosecondType>();
1915        test_layout::<IntervalMonthDayNanoType>();
1916        test_layout::<IntervalDayTimeType>();
1917        test_layout::<IntervalYearMonthType>();
1918        test_layout::<DurationNanosecondType>();
1919        test_layout::<DurationMicrosecondType>();
1920        test_layout::<DurationMillisecondType>();
1921        test_layout::<DurationSecondType>();
1922    }
1923
1924    #[test]
1925    fn timestamp_from_datetime() {
1926        use chrono::{FixedOffset, NaiveDate, NaiveTime, Utc};
1927
1928        // Test UTC timezone
1929        let date = NaiveDate::from_ymd_opt(2021, 1, 1).unwrap();
1930        let time = NaiveTime::from_hms_opt(12, 0, 0).unwrap();
1931        let naive = NaiveDateTime::new(date, time);
1932        let datetime_utc = Utc.from_utc_datetime(&naive);
1933
1934        assert_eq!(
1935            TimestampSecondType::from_datetime(datetime_utc).unwrap(),
1936            1609502400
1937        );
1938        assert_eq!(
1939            TimestampMillisecondType::from_datetime(datetime_utc).unwrap(),
1940            1609502400000
1941        );
1942        assert_eq!(
1943            TimestampMicrosecondType::from_datetime(datetime_utc).unwrap(),
1944            1609502400000000
1945        );
1946        assert_eq!(
1947            TimestampNanosecondType::from_datetime(datetime_utc).unwrap(),
1948            1609502400000000000
1949        );
1950
1951        // Test FixedOffset timezone (+8:00): 12:00+8 = 04:00 UTC
1952        let tz_plus_8 = FixedOffset::east_opt(8 * 3600).unwrap();
1953        let datetime_plus_8 = tz_plus_8.from_local_datetime(&naive).unwrap();
1954        assert_eq!(
1955            TimestampSecondType::from_datetime(datetime_plus_8).unwrap(),
1956            1609502400 - 28800
1957        );
1958
1959        // Test subsecond precision
1960        let datetime = DateTime::from_timestamp(1000000000, 123456789).unwrap();
1961        assert_eq!(
1962            TimestampSecondType::from_datetime(datetime).unwrap(),
1963            1000000000
1964        );
1965        assert_eq!(
1966            TimestampMillisecondType::from_datetime(datetime).unwrap(),
1967            1000000000123
1968        );
1969        assert_eq!(
1970            TimestampMicrosecondType::from_datetime(datetime).unwrap(),
1971            1000000000123456
1972        );
1973        assert_eq!(
1974            TimestampNanosecondType::from_datetime(datetime).unwrap(),
1975            1000000000123456789
1976        );
1977    }
1978
1979    #[test]
1980    fn timestamp_from_datetime_overflow() {
1981        // Nanosecond precision has ~584 year range (1677-2262), easily overflows
1982        let far_past = DateTime::from_timestamp(-10_000_000_000, 0).unwrap();
1983        assert!(TimestampNanosecondType::from_datetime(far_past).is_none());
1984        // Other precisions should handle the same DateTime without overflow
1985        assert!(TimestampSecondType::from_datetime(far_past).is_some());
1986        assert!(TimestampMillisecondType::from_datetime(far_past).is_some());
1987        assert!(TimestampMicrosecondType::from_datetime(far_past).is_some());
1988
1989        let far_future = DateTime::from_timestamp(10_000_000_000, 0).unwrap();
1990        assert!(TimestampNanosecondType::from_datetime(far_future).is_none());
1991        assert!(TimestampSecondType::from_datetime(far_future).is_some());
1992        assert!(TimestampMillisecondType::from_datetime(far_future).is_some());
1993        assert!(TimestampMicrosecondType::from_datetime(far_future).is_some());
1994    }
1995
1996    #[test]
1997    fn timestamp_from_naive_datetime() {
1998        use crate::temporal_conversions::as_datetime_with_timezone;
1999        use chrono::{NaiveDate, NaiveTime};
2000
2001        let date = NaiveDate::from_ymd_opt(2021, 1, 1).unwrap();
2002        let time = NaiveTime::from_hms_opt(12, 0, 0).unwrap();
2003        let naive = NaiveDateTime::new(date, time);
2004
2005        // Test UTC (tz=None)
2006        assert_eq!(
2007            TimestampSecondType::from_naive_datetime(naive, None).unwrap(),
2008            1609502400
2009        );
2010        assert_eq!(
2011            TimestampMillisecondType::from_naive_datetime(naive, None).unwrap(),
2012            1609502400000
2013        );
2014
2015        // Test with timezone (-05:00): 12:00-5 = 17:00 UTC
2016        let tz: Tz = "-05:00".parse().unwrap();
2017        let ts_sec = TimestampSecondType::from_naive_datetime(naive, Some(&tz)).unwrap();
2018        assert_eq!(ts_sec, 1609502400 + 5 * 3600);
2019
2020        // Test all types with timezone and roundtrip
2021        let date = NaiveDate::from_ymd_opt(2024, 6, 15).unwrap();
2022        let time = NaiveTime::from_hms_opt(14, 30, 45).unwrap();
2023        let naive = NaiveDateTime::new(date, time);
2024        let tz: Tz = "+01:00".parse().unwrap();
2025
2026        let ts_usec = TimestampMicrosecondType::from_naive_datetime(naive, Some(&tz)).unwrap();
2027        let recovered = as_datetime_with_timezone::<TimestampMicrosecondType>(ts_usec, tz).unwrap();
2028        assert_eq!(recovered.naive_local(), naive);
2029    }
2030
2031    #[test]
2032    #[cfg(feature = "chrono-tz")]
2033    fn timestamp_from_naive_datetime_ambiguous() {
2034        use chrono::{NaiveDate, NaiveTime};
2035
2036        // 2024-11-03 01:30:00 in US Eastern Time is ambiguous (daylight saving time ends)
2037        // It can be either 01:30:00 EDT (UTC-4) or 01:30:00 EST (UTC-5)
2038        let date = NaiveDate::from_ymd_opt(2024, 11, 3).unwrap();
2039        let time = NaiveTime::from_hms_opt(1, 30, 0).unwrap();
2040        let naive = NaiveDateTime::new(date, time);
2041        let tz: Tz = "America/New_York".parse().unwrap();
2042
2043        // Should return the first/earlier time (EDT, UTC-4) = 05:30:00 UTC
2044        let result = TimestampSecondType::from_naive_datetime(naive, Some(&tz));
2045        assert!(result.is_some());
2046        assert_eq!(result.unwrap(), 1730611800);
2047    }
2048
2049    #[test]
2050    #[cfg(feature = "chrono-tz")]
2051    fn timestamp_from_naive_datetime_none() {
2052        use chrono::{NaiveDate, NaiveTime};
2053
2054        // 2024-03-10 02:30:00 in US Eastern Time doesn't exist
2055        // (daylight saving time starts at 02:00, jumps to 03:00)
2056        let date = NaiveDate::from_ymd_opt(2024, 3, 10).unwrap();
2057        let time = NaiveTime::from_hms_opt(2, 30, 0).unwrap();
2058        let naive = NaiveDateTime::new(date, time);
2059        let tz: Tz = "America/New_York".parse().unwrap();
2060
2061        // Should return None
2062        let result = TimestampSecondType::from_naive_datetime(naive, Some(&tz));
2063        assert!(result.is_none());
2064
2065        // Test for all timestamp types
2066        assert!(TimestampMillisecondType::from_naive_datetime(naive, Some(&tz)).is_none());
2067        assert!(TimestampMicrosecondType::from_naive_datetime(naive, Some(&tz)).is_none());
2068        assert!(TimestampNanosecondType::from_naive_datetime(naive, Some(&tz)).is_none());
2069    }
2070}