1use 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
45pub use arrow_buffer::{IntervalDayTime, IntervalMonthDayNano};
47
48#[derive(Debug)]
52pub struct BooleanType {}
53
54impl BooleanType {
55 pub const DATA_TYPE: DataType = DataType::Boolean;
57}
58
59pub trait ArrowPrimitiveType: primitive::PrimitiveTypeSealed + 'static {
68 type Native: ArrowNativeTypeOp;
70
71 const DATA_TYPE: DataType;
73
74 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
267pub 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
287pub trait RunEndIndexType: ArrowPrimitiveType {}
291
292impl RunEndIndexType for Int16Type {}
293
294impl RunEndIndexType for Int32Type {}
295
296impl RunEndIndexType for Int64Type {}
297
298pub 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 {}
311impl ArrowTemporalType for DurationSecondType {}
315impl ArrowTemporalType for DurationMillisecondType {}
316impl ArrowTemporalType for DurationMicrosecondType {}
317impl ArrowTemporalType for DurationNanosecondType {}
318
319pub trait ArrowTimestampType: ArrowTemporalType<Native = i64> {
321 const UNIT: TimeUnit;
323
324 #[deprecated(since = "58.1.0", note = "Use from_naive_datetime instead")]
328 fn make_value(naive: NaiveDateTime) -> Option<i64>;
329
330 fn from_datetime<Tz: TimeZone>(datetime: DateTime<Tz>) -> Option<i64>;
339
340 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 #[inline]
871 pub fn make_value(
872 years: i32,
873 months: i32,
874 ) -> <IntervalYearMonthType as ArrowPrimitiveType>::Native {
875 years * 12 + months
876 }
877
878 #[inline]
886 pub fn to_months(i: <IntervalYearMonthType as ArrowPrimitiveType>::Native) -> i32 {
887 i
888 }
889}
890
891impl IntervalDayTimeType {
892 #[inline]
899 pub fn make_value(days: i32, milliseconds: i32) -> IntervalDayTime {
900 IntervalDayTime { days, milliseconds }
901 }
902
903 #[inline]
909 pub fn to_parts(i: IntervalDayTime) -> (i32, i32) {
910 (i.days, i.milliseconds)
911 }
912}
913
914impl IntervalMonthDayNanoType {
915 #[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 #[inline]
937 pub fn to_parts(i: IntervalMonthDayNano) -> (i32, i32, i64) {
938 (i.months, i.days, i.nanoseconds)
939 }
940}
941
942impl Date32Type {
943 #[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 pub fn to_naive_date_opt(i: <Date32Type as ArrowPrimitiveType>::Native) -> Option<NaiveDate> {
966 let epoch = NaiveDate::from_ymd_opt(1970, 1, 1).unwrap();
967 Duration::try_days(i as i64).and_then(|d| epoch.checked_add_signed(d))
968 }
969
970 pub fn from_naive_date(d: NaiveDate) -> <Date32Type as ArrowPrimitiveType>::Native {
976 let epoch = NaiveDate::from_ymd_opt(1970, 1, 1).unwrap();
977 d.sub(epoch).num_days() as <Date32Type as ArrowPrimitiveType>::Native
978 }
979
980 #[deprecated(
991 since = "58.0.0",
992 note = "Use `add_year_months_opt` instead, which returns an Option to handle overflow."
993 )]
994 pub fn add_year_months(
995 date: <Date32Type as ArrowPrimitiveType>::Native,
996 delta: <IntervalYearMonthType as ArrowPrimitiveType>::Native,
997 ) -> <Date32Type as ArrowPrimitiveType>::Native {
998 Self::add_year_months_opt(date, delta).unwrap_or_else(|| {
999 panic!("Date32Type::add_year_months overflowed for date: {date}, delta: {delta}",)
1000 })
1001 }
1002
1003 pub fn add_year_months_opt(
1012 date: <Date32Type as ArrowPrimitiveType>::Native,
1013 delta: <IntervalYearMonthType as ArrowPrimitiveType>::Native,
1014 ) -> Option<<Date32Type as ArrowPrimitiveType>::Native> {
1015 let prior = Date32Type::to_naive_date_opt(date)?;
1016 let months = IntervalYearMonthType::to_months(delta);
1017 let posterior = add_months_date(prior, months)?;
1018 Some(Date32Type::from_naive_date(posterior))
1019 }
1020
1021 #[deprecated(
1032 since = "58.0.0",
1033 note = "Use `add_day_time_opt` instead, which returns an Option to handle overflow."
1034 )]
1035 pub fn add_day_time(
1036 date: <Date32Type as ArrowPrimitiveType>::Native,
1037 delta: <IntervalDayTimeType as ArrowPrimitiveType>::Native,
1038 ) -> <Date32Type as ArrowPrimitiveType>::Native {
1039 Self::add_day_time_opt(date, delta).unwrap_or_else(|| {
1040 panic!("Date32Type::add_day_time overflowed for date: {date}, delta: {delta:?}",)
1041 })
1042 }
1043
1044 pub fn add_day_time_opt(
1053 date: <Date32Type as ArrowPrimitiveType>::Native,
1054 delta: <IntervalDayTimeType as ArrowPrimitiveType>::Native,
1055 ) -> Option<<Date32Type as ArrowPrimitiveType>::Native> {
1056 let (days, ms) = IntervalDayTimeType::to_parts(delta);
1057 let res = Date32Type::to_naive_date_opt(date)?;
1058 let res = res.checked_add_signed(Duration::try_days(days as i64)?)?;
1059 let res = res.checked_add_signed(Duration::try_milliseconds(ms as i64)?)?;
1060 Some(Date32Type::from_naive_date(res))
1061 }
1062
1063 #[deprecated(
1074 since = "58.0.0",
1075 note = "Use `add_month_day_nano_opt` instead, which returns an Option to handle overflow."
1076 )]
1077 pub fn add_month_day_nano(
1078 date: <Date32Type as ArrowPrimitiveType>::Native,
1079 delta: <IntervalMonthDayNanoType as ArrowPrimitiveType>::Native,
1080 ) -> <Date32Type as ArrowPrimitiveType>::Native {
1081 Self::add_month_day_nano_opt(date, delta).unwrap_or_else(|| {
1082 panic!("Date32Type::add_month_day_nano overflowed for date: {date}, delta: {delta:?}",)
1083 })
1084 }
1085
1086 pub fn add_month_day_nano_opt(
1095 date: <Date32Type as ArrowPrimitiveType>::Native,
1096 delta: <IntervalMonthDayNanoType as ArrowPrimitiveType>::Native,
1097 ) -> Option<<Date32Type as ArrowPrimitiveType>::Native> {
1098 let (months, days, nanos) = IntervalMonthDayNanoType::to_parts(delta);
1099 let res = Date32Type::to_naive_date_opt(date)?;
1100 let res = add_months_date(res, months)?;
1101 let res = res.checked_add_signed(Duration::try_days(days as i64)?)?;
1102 let res = res.checked_add_signed(Duration::nanoseconds(nanos))?;
1103 Some(Date32Type::from_naive_date(res))
1104 }
1105
1106 #[deprecated(
1117 since = "58.0.0",
1118 note = "Use `subtract_year_months_opt` instead, which returns an Option to handle overflow."
1119 )]
1120 pub fn subtract_year_months(
1121 date: <Date32Type as ArrowPrimitiveType>::Native,
1122 delta: <IntervalYearMonthType as ArrowPrimitiveType>::Native,
1123 ) -> <Date32Type as ArrowPrimitiveType>::Native {
1124 Self::subtract_year_months_opt(date, delta).unwrap_or_else(|| {
1125 panic!("Date32Type::subtract_year_months overflowed for date: {date}, delta: {delta}",)
1126 })
1127 }
1128
1129 pub fn subtract_year_months_opt(
1138 date: <Date32Type as ArrowPrimitiveType>::Native,
1139 delta: <IntervalYearMonthType as ArrowPrimitiveType>::Native,
1140 ) -> Option<<Date32Type as ArrowPrimitiveType>::Native> {
1141 let prior = Date32Type::to_naive_date_opt(date)?;
1142 let months = IntervalYearMonthType::to_months(-delta);
1143 let posterior = add_months_date(prior, months)?;
1144 Some(Date32Type::from_naive_date(posterior))
1145 }
1146
1147 #[deprecated(
1158 since = "58.0.0",
1159 note = "Use `subtract_day_time_opt` instead, which returns an Option to handle overflow."
1160 )]
1161 pub fn subtract_day_time(
1162 date: <Date32Type as ArrowPrimitiveType>::Native,
1163 delta: <IntervalDayTimeType as ArrowPrimitiveType>::Native,
1164 ) -> <Date32Type as ArrowPrimitiveType>::Native {
1165 Self::subtract_day_time_opt(date, delta).unwrap_or_else(|| {
1166 panic!("Date32Type::subtract_day_time overflowed for date: {date}, delta: {delta:?}",)
1167 })
1168 }
1169
1170 pub fn subtract_day_time_opt(
1179 date: <Date32Type as ArrowPrimitiveType>::Native,
1180 delta: <IntervalDayTimeType as ArrowPrimitiveType>::Native,
1181 ) -> Option<<Date32Type as ArrowPrimitiveType>::Native> {
1182 let (days, ms) = IntervalDayTimeType::to_parts(delta);
1183 let res = Date32Type::to_naive_date_opt(date)?;
1184 let res = res.checked_sub_signed(Duration::try_days(days as i64)?)?;
1185 let res = res.checked_sub_signed(Duration::try_milliseconds(ms as i64)?)?;
1186 Some(Date32Type::from_naive_date(res))
1187 }
1188
1189 #[deprecated(
1200 since = "58.0.0",
1201 note = "Use `subtract_month_day_nano_opt` instead, which returns an Option to handle overflow."
1202 )]
1203 pub fn subtract_month_day_nano(
1204 date: <Date32Type as ArrowPrimitiveType>::Native,
1205 delta: <IntervalMonthDayNanoType as ArrowPrimitiveType>::Native,
1206 ) -> <Date32Type as ArrowPrimitiveType>::Native {
1207 Self::subtract_month_day_nano_opt(date, delta).unwrap_or_else(|| {
1208 panic!(
1209 "Date32Type::subtract_month_day_nano overflowed for date: {date}, delta: {delta:?}",
1210 )
1211 })
1212 }
1213
1214 pub fn subtract_month_day_nano_opt(
1223 date: <Date32Type as ArrowPrimitiveType>::Native,
1224 delta: <IntervalMonthDayNanoType as ArrowPrimitiveType>::Native,
1225 ) -> Option<<Date32Type as ArrowPrimitiveType>::Native> {
1226 let (months, days, nanos) = IntervalMonthDayNanoType::to_parts(delta);
1227 let res = Date32Type::to_naive_date_opt(date)?;
1228 let res = add_months_date(res, -months)?;
1229 let res = res.checked_sub_signed(Duration::try_days(days as i64)?)?;
1230 let res = res.checked_sub_signed(Duration::nanoseconds(nanos))?;
1231 Some(Date32Type::from_naive_date(res))
1232 }
1233}
1234
1235impl Date64Type {
1236 pub fn to_naive_date_opt(i: <Date64Type as ArrowPrimitiveType>::Native) -> Option<NaiveDate> {
1247 let epoch = NaiveDate::from_ymd_opt(1970, 1, 1).unwrap();
1248 Duration::try_milliseconds(i).and_then(|d| epoch.checked_add_signed(d))
1249 }
1250
1251 pub fn from_naive_date(d: NaiveDate) -> <Date64Type as ArrowPrimitiveType>::Native {
1257 let epoch = NaiveDate::from_ymd_opt(1970, 1, 1).unwrap();
1258 d.sub(epoch).num_milliseconds()
1259 }
1260
1261 pub fn add_year_months_opt(
1270 date: <Date64Type as ArrowPrimitiveType>::Native,
1271 delta: <IntervalYearMonthType as ArrowPrimitiveType>::Native,
1272 ) -> Option<<Date64Type as ArrowPrimitiveType>::Native> {
1273 let prior = Date64Type::to_naive_date_opt(date)?;
1274 let months = IntervalYearMonthType::to_months(delta);
1275 let posterior = add_months_date(prior, months)?;
1276 Some(Date64Type::from_naive_date(posterior))
1277 }
1278
1279 pub fn add_day_time_opt(
1288 date: <Date64Type as ArrowPrimitiveType>::Native,
1289 delta: <IntervalDayTimeType as ArrowPrimitiveType>::Native,
1290 ) -> Option<<Date64Type as ArrowPrimitiveType>::Native> {
1291 let (days, ms) = IntervalDayTimeType::to_parts(delta);
1292 let res = Date64Type::to_naive_date_opt(date)?;
1293 let res = res.checked_add_signed(Duration::try_days(days as i64)?)?;
1294 let res = res.checked_add_signed(Duration::try_milliseconds(ms as i64)?)?;
1295 Some(Date64Type::from_naive_date(res))
1296 }
1297
1298 pub fn add_month_day_nano_opt(
1307 date: <Date64Type as ArrowPrimitiveType>::Native,
1308 delta: <IntervalMonthDayNanoType as ArrowPrimitiveType>::Native,
1309 ) -> Option<<Date64Type as ArrowPrimitiveType>::Native> {
1310 let (months, days, nanos) = IntervalMonthDayNanoType::to_parts(delta);
1311 let res = Date64Type::to_naive_date_opt(date)?;
1312 let res = add_months_date(res, months)?;
1313 let res = res.checked_add_signed(Duration::try_days(days as i64)?)?;
1314 let res = res.checked_add_signed(Duration::nanoseconds(nanos))?;
1315 Some(Date64Type::from_naive_date(res))
1316 }
1317
1318 pub fn subtract_year_months_opt(
1327 date: <Date64Type as ArrowPrimitiveType>::Native,
1328 delta: <IntervalYearMonthType as ArrowPrimitiveType>::Native,
1329 ) -> Option<<Date64Type as ArrowPrimitiveType>::Native> {
1330 let prior = Date64Type::to_naive_date_opt(date)?;
1331 let months = IntervalYearMonthType::to_months(-delta);
1332 let posterior = add_months_date(prior, months)?;
1333 Some(Date64Type::from_naive_date(posterior))
1334 }
1335
1336 pub fn subtract_day_time_opt(
1345 date: <Date64Type as ArrowPrimitiveType>::Native,
1346 delta: <IntervalDayTimeType as ArrowPrimitiveType>::Native,
1347 ) -> Option<<Date64Type as ArrowPrimitiveType>::Native> {
1348 let (days, ms) = IntervalDayTimeType::to_parts(delta);
1349 let res = Date64Type::to_naive_date_opt(date)?;
1350 let res = res.checked_sub_signed(Duration::try_days(days as i64)?)?;
1351 let res = res.checked_sub_signed(Duration::try_milliseconds(ms as i64)?)?;
1352 Some(Date64Type::from_naive_date(res))
1353 }
1354
1355 pub fn subtract_month_day_nano_opt(
1364 date: <Date64Type as ArrowPrimitiveType>::Native,
1365 delta: <IntervalMonthDayNanoType as ArrowPrimitiveType>::Native,
1366 ) -> Option<<Date64Type as ArrowPrimitiveType>::Native> {
1367 let (months, days, nanos) = IntervalMonthDayNanoType::to_parts(delta);
1368 let res = Date64Type::to_naive_date_opt(date)?;
1369 let res = add_months_date(res, -months)?;
1370 let res = res.checked_sub_signed(Duration::try_days(days as i64)?)?;
1371 let res = res.checked_sub_signed(Duration::nanoseconds(nanos))?;
1372 Some(Date64Type::from_naive_date(res))
1373 }
1374}
1375
1376mod decimal {
1380 use super::*;
1381
1382 pub trait DecimalTypeSealed {}
1383 impl DecimalTypeSealed for Decimal32Type {}
1384 impl DecimalTypeSealed for Decimal64Type {}
1385 impl DecimalTypeSealed for Decimal128Type {}
1386 impl DecimalTypeSealed for Decimal256Type {}
1387}
1388
1389pub trait DecimalType:
1401 'static + Send + Sync + ArrowPrimitiveType + decimal::DecimalTypeSealed
1402{
1403 const BYTE_LENGTH: usize;
1405 const MAX_PRECISION: u8;
1407 const MAX_SCALE: i8;
1409 const MAX_FOR_EACH_PRECISION: &'static [Self::Native];
1411 const TYPE_CONSTRUCTOR: fn(u8, i8) -> DataType;
1413 const DEFAULT_TYPE: DataType;
1415
1416 const PREFIX: &'static str;
1418
1419 fn format_decimal(value: Self::Native, precision: u8, scale: i8) -> String;
1421
1422 fn validate_decimal_precision(
1424 value: Self::Native,
1425 precision: u8,
1426 scale: i8,
1427 ) -> Result<(), ArrowError>;
1428
1429 fn is_valid_decimal_precision(value: Self::Native, precision: u8) -> bool;
1431}
1432
1433pub fn validate_decimal_precision_and_scale<T: DecimalType>(
1441 precision: u8,
1442 scale: i8,
1443) -> Result<(), ArrowError> {
1444 if precision == 0 {
1445 return Err(ArrowError::InvalidArgumentError(format!(
1446 "precision cannot be 0, has to be between [1, {}]",
1447 T::MAX_PRECISION
1448 )));
1449 }
1450 if precision > T::MAX_PRECISION {
1451 return Err(ArrowError::InvalidArgumentError(format!(
1452 "precision {} is greater than max {}",
1453 precision,
1454 T::MAX_PRECISION
1455 )));
1456 }
1457 if scale > T::MAX_SCALE {
1458 return Err(ArrowError::InvalidArgumentError(format!(
1459 "scale {} is greater than max {}",
1460 scale,
1461 T::MAX_SCALE
1462 )));
1463 }
1464 if scale > 0 && scale as u8 > precision {
1465 return Err(ArrowError::InvalidArgumentError(format!(
1466 "scale {scale} is greater than precision {precision}"
1467 )));
1468 }
1469
1470 Ok(())
1471}
1472
1473#[derive(Debug)]
1475pub struct Decimal32Type {}
1476
1477impl DecimalType for Decimal32Type {
1478 const BYTE_LENGTH: usize = 4;
1479 const MAX_PRECISION: u8 = DECIMAL32_MAX_PRECISION;
1480 const MAX_SCALE: i8 = DECIMAL32_MAX_SCALE;
1481 const MAX_FOR_EACH_PRECISION: &'static [i32] =
1482 &arrow_data::decimal::MAX_DECIMAL32_FOR_EACH_PRECISION;
1483 const TYPE_CONSTRUCTOR: fn(u8, i8) -> DataType = DataType::Decimal32;
1484 const DEFAULT_TYPE: DataType =
1485 DataType::Decimal32(DECIMAL32_MAX_PRECISION, DECIMAL32_DEFAULT_SCALE);
1486 const PREFIX: &'static str = "Decimal32";
1487
1488 fn format_decimal(value: Self::Native, precision: u8, scale: i8) -> String {
1489 format_decimal_str(&value.to_string(), precision as usize, scale)
1490 }
1491
1492 fn validate_decimal_precision(num: i32, precision: u8, scale: i8) -> Result<(), ArrowError> {
1493 validate_decimal32_precision(num, precision, scale)
1494 }
1495
1496 fn is_valid_decimal_precision(value: Self::Native, precision: u8) -> bool {
1497 is_validate_decimal32_precision(value, precision)
1498 }
1499}
1500
1501impl ArrowPrimitiveType for Decimal32Type {
1502 type Native = i32;
1503
1504 const DATA_TYPE: DataType = <Self as DecimalType>::DEFAULT_TYPE;
1505}
1506
1507impl primitive::PrimitiveTypeSealed for Decimal32Type {}
1508
1509#[derive(Debug)]
1511pub struct Decimal64Type {}
1512
1513impl DecimalType for Decimal64Type {
1514 const BYTE_LENGTH: usize = 8;
1515 const MAX_PRECISION: u8 = DECIMAL64_MAX_PRECISION;
1516 const MAX_SCALE: i8 = DECIMAL64_MAX_SCALE;
1517 const MAX_FOR_EACH_PRECISION: &'static [i64] =
1518 &arrow_data::decimal::MAX_DECIMAL64_FOR_EACH_PRECISION;
1519 const TYPE_CONSTRUCTOR: fn(u8, i8) -> DataType = DataType::Decimal64;
1520 const DEFAULT_TYPE: DataType =
1521 DataType::Decimal64(DECIMAL64_MAX_PRECISION, DECIMAL64_DEFAULT_SCALE);
1522 const PREFIX: &'static str = "Decimal64";
1523
1524 fn format_decimal(value: Self::Native, precision: u8, scale: i8) -> String {
1525 format_decimal_str(&value.to_string(), precision as usize, scale)
1526 }
1527
1528 fn validate_decimal_precision(num: i64, precision: u8, scale: i8) -> Result<(), ArrowError> {
1529 validate_decimal64_precision(num, precision, scale)
1530 }
1531
1532 fn is_valid_decimal_precision(value: Self::Native, precision: u8) -> bool {
1533 is_validate_decimal64_precision(value, precision)
1534 }
1535}
1536
1537impl ArrowPrimitiveType for Decimal64Type {
1538 type Native = i64;
1539
1540 const DATA_TYPE: DataType = <Self as DecimalType>::DEFAULT_TYPE;
1541}
1542
1543impl primitive::PrimitiveTypeSealed for Decimal64Type {}
1544
1545#[derive(Debug)]
1547pub struct Decimal128Type {}
1548
1549impl DecimalType for Decimal128Type {
1550 const BYTE_LENGTH: usize = 16;
1551 const MAX_PRECISION: u8 = DECIMAL128_MAX_PRECISION;
1552 const MAX_SCALE: i8 = DECIMAL128_MAX_SCALE;
1553 const MAX_FOR_EACH_PRECISION: &'static [i128] =
1554 &arrow_data::decimal::MAX_DECIMAL128_FOR_EACH_PRECISION;
1555 const TYPE_CONSTRUCTOR: fn(u8, i8) -> DataType = DataType::Decimal128;
1556 const DEFAULT_TYPE: DataType =
1557 DataType::Decimal128(DECIMAL128_MAX_PRECISION, DECIMAL_DEFAULT_SCALE);
1558 const PREFIX: &'static str = "Decimal128";
1559
1560 fn format_decimal(value: Self::Native, precision: u8, scale: i8) -> String {
1561 format_decimal_str(&value.to_string(), precision as usize, scale)
1562 }
1563
1564 fn validate_decimal_precision(num: i128, precision: u8, scale: i8) -> Result<(), ArrowError> {
1565 validate_decimal_precision(num, precision, scale)
1566 }
1567
1568 fn is_valid_decimal_precision(value: Self::Native, precision: u8) -> bool {
1569 is_validate_decimal_precision(value, precision)
1570 }
1571}
1572
1573impl ArrowPrimitiveType for Decimal128Type {
1574 type Native = i128;
1575
1576 const DATA_TYPE: DataType = <Self as DecimalType>::DEFAULT_TYPE;
1577}
1578
1579impl primitive::PrimitiveTypeSealed for Decimal128Type {}
1580
1581#[derive(Debug)]
1583pub struct Decimal256Type {}
1584
1585impl DecimalType for Decimal256Type {
1586 const BYTE_LENGTH: usize = 32;
1587 const MAX_PRECISION: u8 = DECIMAL256_MAX_PRECISION;
1588 const MAX_SCALE: i8 = DECIMAL256_MAX_SCALE;
1589 const MAX_FOR_EACH_PRECISION: &'static [i256] =
1590 &arrow_data::decimal::MAX_DECIMAL256_FOR_EACH_PRECISION;
1591 const TYPE_CONSTRUCTOR: fn(u8, i8) -> DataType = DataType::Decimal256;
1592 const DEFAULT_TYPE: DataType =
1593 DataType::Decimal256(DECIMAL256_MAX_PRECISION, DECIMAL_DEFAULT_SCALE);
1594 const PREFIX: &'static str = "Decimal256";
1595
1596 fn format_decimal(value: Self::Native, precision: u8, scale: i8) -> String {
1597 format_decimal_str(&value.to_string(), precision as usize, scale)
1598 }
1599
1600 fn validate_decimal_precision(num: i256, precision: u8, scale: i8) -> Result<(), ArrowError> {
1601 validate_decimal256_precision(num, precision, scale)
1602 }
1603
1604 fn is_valid_decimal_precision(value: Self::Native, precision: u8) -> bool {
1605 is_validate_decimal256_precision(value, precision)
1606 }
1607}
1608
1609impl ArrowPrimitiveType for Decimal256Type {
1610 type Native = i256;
1611
1612 const DATA_TYPE: DataType = <Self as DecimalType>::DEFAULT_TYPE;
1613}
1614
1615impl primitive::PrimitiveTypeSealed for Decimal256Type {}
1616
1617pub(crate) mod bytes {
1621 use super::*;
1622
1623 pub trait ByteArrayTypeSealed {}
1624 impl<O: OffsetSizeTrait> ByteArrayTypeSealed for GenericStringType<O> {}
1625 impl<O: OffsetSizeTrait> ByteArrayTypeSealed for GenericBinaryType<O> {}
1626
1627 pub trait ByteArrayNativeType: std::fmt::Debug + Send + Sync {
1628 fn from_bytes_checked(b: &[u8]) -> Option<&Self>;
1629
1630 unsafe fn from_bytes_unchecked(b: &[u8]) -> &Self;
1634 }
1635
1636 impl ByteArrayNativeType for [u8] {
1637 #[inline]
1638 fn from_bytes_checked(b: &[u8]) -> Option<&Self> {
1639 Some(b)
1640 }
1641
1642 #[inline]
1643 unsafe fn from_bytes_unchecked(b: &[u8]) -> &Self {
1644 b
1645 }
1646 }
1647
1648 impl ByteArrayNativeType for str {
1649 #[inline]
1650 fn from_bytes_checked(b: &[u8]) -> Option<&Self> {
1651 std::str::from_utf8(b).ok()
1652 }
1653
1654 #[inline]
1655 unsafe fn from_bytes_unchecked(b: &[u8]) -> &Self {
1656 unsafe { std::str::from_utf8_unchecked(b) }
1657 }
1658 }
1659}
1660
1661pub trait ByteArrayType: 'static + Send + Sync + bytes::ByteArrayTypeSealed {
1665 type Offset: OffsetSizeTrait;
1667 type Native: bytes::ByteArrayNativeType + AsRef<Self::Native> + AsRef<[u8]> + ?Sized;
1671
1672 const PREFIX: &'static str;
1674
1675 const DATA_TYPE: DataType;
1677
1678 fn validate(offsets: &OffsetBuffer<Self::Offset>, values: &Buffer) -> Result<(), ArrowError>;
1680}
1681
1682pub struct GenericStringType<O: OffsetSizeTrait> {
1684 phantom: PhantomData<O>,
1685}
1686
1687impl<O: OffsetSizeTrait> ByteArrayType for GenericStringType<O> {
1688 type Offset = O;
1689 type Native = str;
1690 const PREFIX: &'static str = "String";
1691
1692 const DATA_TYPE: DataType = if O::IS_LARGE {
1693 DataType::LargeUtf8
1694 } else {
1695 DataType::Utf8
1696 };
1697
1698 fn validate(offsets: &OffsetBuffer<Self::Offset>, values: &Buffer) -> Result<(), ArrowError> {
1699 let validated = std::str::from_utf8(values).map_err(|e| {
1701 ArrowError::InvalidArgumentError(format!("Encountered non UTF-8 data: {e}"))
1702 })?;
1703
1704 for offset in offsets.iter() {
1706 let o = offset.as_usize();
1707 if !validated.is_char_boundary(o) {
1708 if o < validated.len() {
1709 return Err(ArrowError::InvalidArgumentError(format!(
1710 "Split UTF-8 codepoint at offset {o}"
1711 )));
1712 }
1713 return Err(ArrowError::InvalidArgumentError(format!(
1714 "Offset of {o} exceeds length of values {}",
1715 validated.len()
1716 )));
1717 }
1718 }
1719 Ok(())
1720 }
1721}
1722
1723pub type Utf8Type = GenericStringType<i32>;
1725pub type LargeUtf8Type = GenericStringType<i64>;
1727
1728pub struct GenericBinaryType<O: OffsetSizeTrait> {
1730 phantom: PhantomData<O>,
1731}
1732
1733impl<O: OffsetSizeTrait> ByteArrayType for GenericBinaryType<O> {
1734 type Offset = O;
1735 type Native = [u8];
1736 const PREFIX: &'static str = "Binary";
1737
1738 const DATA_TYPE: DataType = if O::IS_LARGE {
1739 DataType::LargeBinary
1740 } else {
1741 DataType::Binary
1742 };
1743
1744 fn validate(offsets: &OffsetBuffer<Self::Offset>, values: &Buffer) -> Result<(), ArrowError> {
1745 let max_offset = offsets.last().unwrap().as_usize();
1747 if values.len() < max_offset {
1748 return Err(ArrowError::InvalidArgumentError(format!(
1749 "Maximum offset of {max_offset} is larger than values of length {}",
1750 values.len()
1751 )));
1752 }
1753 Ok(())
1754 }
1755}
1756
1757pub type BinaryType = GenericBinaryType<i32>;
1759pub type LargeBinaryType = GenericBinaryType<i64>;
1761
1762mod byte_view {
1763 use crate::types::{BinaryViewType, StringViewType};
1764
1765 pub trait Sealed: Send + Sync {}
1766 impl Sealed for StringViewType {}
1767 impl Sealed for BinaryViewType {}
1768}
1769
1770pub trait ByteViewType: byte_view::Sealed + 'static + PartialEq + Send + Sync {
1772 const IS_UTF8: bool;
1774
1775 const DATA_TYPE: DataType = if Self::IS_UTF8 {
1777 DataType::Utf8View
1778 } else {
1779 DataType::BinaryView
1780 };
1781
1782 const PREFIX: &'static str;
1784
1785 type Native: bytes::ByteArrayNativeType + AsRef<Self::Native> + AsRef<[u8]> + ?Sized;
1789
1790 type Owned: Debug + Clone + Sync + Send + AsRef<Self::Native>;
1792
1793 fn validate(views: &[u128], buffers: &[Buffer]) -> Result<(), ArrowError>;
1795}
1796
1797#[derive(PartialEq)]
1799pub struct StringViewType {}
1800
1801impl ByteViewType for StringViewType {
1802 const IS_UTF8: bool = true;
1803 const PREFIX: &'static str = "String";
1804
1805 type Native = str;
1806 type Owned = String;
1807
1808 fn validate(views: &[u128], buffers: &[Buffer]) -> Result<(), ArrowError> {
1809 validate_string_view(views, buffers)
1810 }
1811}
1812
1813#[derive(PartialEq)]
1815pub struct BinaryViewType {}
1816
1817impl ByteViewType for BinaryViewType {
1818 const IS_UTF8: bool = false;
1819 const PREFIX: &'static str = "Binary";
1820 type Native = [u8];
1821 type Owned = Vec<u8>;
1822
1823 fn validate(views: &[u128], buffers: &[Buffer]) -> Result<(), ArrowError> {
1824 validate_binary_view(views, buffers)
1825 }
1826}
1827
1828#[cfg(test)]
1829mod tests {
1830 use super::*;
1831 use arrow_data::{BufferSpec, layout};
1832 use chrono::DateTime;
1833
1834 #[test]
1835 fn month_day_nano_should_roundtrip() {
1836 let value = IntervalMonthDayNanoType::make_value(1, 2, 3);
1837 assert_eq!(IntervalMonthDayNanoType::to_parts(value), (1, 2, 3));
1838 }
1839
1840 #[test]
1841 fn month_day_nano_should_roundtrip_neg() {
1842 let value = IntervalMonthDayNanoType::make_value(-1, -2, -3);
1843 assert_eq!(IntervalMonthDayNanoType::to_parts(value), (-1, -2, -3));
1844 }
1845
1846 #[test]
1847 fn day_time_should_roundtrip() {
1848 let value = IntervalDayTimeType::make_value(1, 2);
1849 assert_eq!(IntervalDayTimeType::to_parts(value), (1, 2));
1850 }
1851
1852 #[test]
1853 fn day_time_should_roundtrip_neg() {
1854 let value = IntervalDayTimeType::make_value(-1, -2);
1855 assert_eq!(IntervalDayTimeType::to_parts(value), (-1, -2));
1856 }
1857
1858 #[test]
1859 fn year_month_should_roundtrip() {
1860 let value = IntervalYearMonthType::make_value(1, 2);
1861 assert_eq!(IntervalYearMonthType::to_months(value), 14);
1862 }
1863
1864 #[test]
1865 fn year_month_should_roundtrip_neg() {
1866 let value = IntervalYearMonthType::make_value(-1, -2);
1867 assert_eq!(IntervalYearMonthType::to_months(value), -14);
1868 }
1869
1870 fn test_layout<T: ArrowPrimitiveType>() {
1871 let layout = layout(&T::DATA_TYPE);
1872
1873 assert_eq!(layout.buffers.len(), 1);
1874
1875 let spec = &layout.buffers[0];
1876 assert_eq!(
1877 spec,
1878 &BufferSpec::FixedWidth {
1879 byte_width: std::mem::size_of::<T::Native>(),
1880 alignment: std::mem::align_of::<T::Native>(),
1881 }
1882 );
1883 }
1884
1885 #[test]
1886 fn test_layouts() {
1887 test_layout::<Int8Type>();
1888 test_layout::<Int16Type>();
1889 test_layout::<Int32Type>();
1890 test_layout::<Int64Type>();
1891 test_layout::<UInt8Type>();
1892 test_layout::<UInt16Type>();
1893 test_layout::<UInt32Type>();
1894 test_layout::<UInt64Type>();
1895 test_layout::<Float16Type>();
1896 test_layout::<Float32Type>();
1897 test_layout::<Float64Type>();
1898 test_layout::<Decimal32Type>();
1899 test_layout::<Decimal64Type>();
1900 test_layout::<Decimal128Type>();
1901 test_layout::<Decimal256Type>();
1902 test_layout::<TimestampNanosecondType>();
1903 test_layout::<TimestampMillisecondType>();
1904 test_layout::<TimestampMicrosecondType>();
1905 test_layout::<TimestampNanosecondType>();
1906 test_layout::<TimestampSecondType>();
1907 test_layout::<Date32Type>();
1908 test_layout::<Date64Type>();
1909 test_layout::<Time32SecondType>();
1910 test_layout::<Time32MillisecondType>();
1911 test_layout::<Time64MicrosecondType>();
1912 test_layout::<Time64NanosecondType>();
1913 test_layout::<IntervalMonthDayNanoType>();
1914 test_layout::<IntervalDayTimeType>();
1915 test_layout::<IntervalYearMonthType>();
1916 test_layout::<DurationNanosecondType>();
1917 test_layout::<DurationMicrosecondType>();
1918 test_layout::<DurationMillisecondType>();
1919 test_layout::<DurationSecondType>();
1920 }
1921
1922 #[test]
1923 fn timestamp_from_datetime() {
1924 use chrono::{FixedOffset, NaiveDate, NaiveTime, Utc};
1925
1926 let date = NaiveDate::from_ymd_opt(2021, 1, 1).unwrap();
1928 let time = NaiveTime::from_hms_opt(12, 0, 0).unwrap();
1929 let naive = NaiveDateTime::new(date, time);
1930 let datetime_utc = Utc.from_utc_datetime(&naive);
1931
1932 assert_eq!(
1933 TimestampSecondType::from_datetime(datetime_utc).unwrap(),
1934 1609502400
1935 );
1936 assert_eq!(
1937 TimestampMillisecondType::from_datetime(datetime_utc).unwrap(),
1938 1609502400000
1939 );
1940 assert_eq!(
1941 TimestampMicrosecondType::from_datetime(datetime_utc).unwrap(),
1942 1609502400000000
1943 );
1944 assert_eq!(
1945 TimestampNanosecondType::from_datetime(datetime_utc).unwrap(),
1946 1609502400000000000
1947 );
1948
1949 let tz_plus_8 = FixedOffset::east_opt(8 * 3600).unwrap();
1951 let datetime_plus_8 = tz_plus_8.from_local_datetime(&naive).unwrap();
1952 assert_eq!(
1953 TimestampSecondType::from_datetime(datetime_plus_8).unwrap(),
1954 1609502400 - 28800
1955 );
1956
1957 let datetime = DateTime::from_timestamp(1000000000, 123456789).unwrap();
1959 assert_eq!(
1960 TimestampSecondType::from_datetime(datetime).unwrap(),
1961 1000000000
1962 );
1963 assert_eq!(
1964 TimestampMillisecondType::from_datetime(datetime).unwrap(),
1965 1000000000123
1966 );
1967 assert_eq!(
1968 TimestampMicrosecondType::from_datetime(datetime).unwrap(),
1969 1000000000123456
1970 );
1971 assert_eq!(
1972 TimestampNanosecondType::from_datetime(datetime).unwrap(),
1973 1000000000123456789
1974 );
1975 }
1976
1977 #[test]
1978 fn timestamp_from_datetime_overflow() {
1979 let far_past = DateTime::from_timestamp(-10_000_000_000, 0).unwrap();
1981 assert!(TimestampNanosecondType::from_datetime(far_past).is_none());
1982 assert!(TimestampSecondType::from_datetime(far_past).is_some());
1984 assert!(TimestampMillisecondType::from_datetime(far_past).is_some());
1985 assert!(TimestampMicrosecondType::from_datetime(far_past).is_some());
1986
1987 let far_future = DateTime::from_timestamp(10_000_000_000, 0).unwrap();
1988 assert!(TimestampNanosecondType::from_datetime(far_future).is_none());
1989 assert!(TimestampSecondType::from_datetime(far_future).is_some());
1990 assert!(TimestampMillisecondType::from_datetime(far_future).is_some());
1991 assert!(TimestampMicrosecondType::from_datetime(far_future).is_some());
1992 }
1993
1994 #[test]
1995 fn timestamp_from_naive_datetime() {
1996 use crate::temporal_conversions::as_datetime_with_timezone;
1997 use chrono::{NaiveDate, NaiveTime};
1998
1999 let date = NaiveDate::from_ymd_opt(2021, 1, 1).unwrap();
2000 let time = NaiveTime::from_hms_opt(12, 0, 0).unwrap();
2001 let naive = NaiveDateTime::new(date, time);
2002
2003 assert_eq!(
2005 TimestampSecondType::from_naive_datetime(naive, None).unwrap(),
2006 1609502400
2007 );
2008 assert_eq!(
2009 TimestampMillisecondType::from_naive_datetime(naive, None).unwrap(),
2010 1609502400000
2011 );
2012
2013 let tz: Tz = "-05:00".parse().unwrap();
2015 let ts_sec = TimestampSecondType::from_naive_datetime(naive, Some(&tz)).unwrap();
2016 assert_eq!(ts_sec, 1609502400 + 5 * 3600);
2017
2018 let date = NaiveDate::from_ymd_opt(2024, 6, 15).unwrap();
2020 let time = NaiveTime::from_hms_opt(14, 30, 45).unwrap();
2021 let naive = NaiveDateTime::new(date, time);
2022 let tz: Tz = "+01:00".parse().unwrap();
2023
2024 let ts_usec = TimestampMicrosecondType::from_naive_datetime(naive, Some(&tz)).unwrap();
2025 let recovered = as_datetime_with_timezone::<TimestampMicrosecondType>(ts_usec, tz).unwrap();
2026 assert_eq!(recovered.naive_local(), naive);
2027 }
2028
2029 #[test]
2030 #[cfg(feature = "chrono-tz")]
2031 fn timestamp_from_naive_datetime_ambiguous() {
2032 use chrono::{NaiveDate, NaiveTime};
2033
2034 let date = NaiveDate::from_ymd_opt(2024, 11, 3).unwrap();
2037 let time = NaiveTime::from_hms_opt(1, 30, 0).unwrap();
2038 let naive = NaiveDateTime::new(date, time);
2039 let tz: Tz = "America/New_York".parse().unwrap();
2040
2041 let result = TimestampSecondType::from_naive_datetime(naive, Some(&tz));
2043 assert!(result.is_some());
2044 assert_eq!(result.unwrap(), 1730611800);
2045 }
2046
2047 #[test]
2048 #[cfg(feature = "chrono-tz")]
2049 fn timestamp_from_naive_datetime_none() {
2050 use chrono::{NaiveDate, NaiveTime};
2051
2052 let date = NaiveDate::from_ymd_opt(2024, 3, 10).unwrap();
2055 let time = NaiveTime::from_hms_opt(2, 30, 0).unwrap();
2056 let naive = NaiveDateTime::new(date, time);
2057 let tz: Tz = "America/New_York".parse().unwrap();
2058
2059 let result = TimestampSecondType::from_naive_datetime(naive, Some(&tz));
2061 assert!(result.is_none());
2062
2063 assert!(TimestampMillisecondType::from_naive_datetime(naive, Some(&tz)).is_none());
2065 assert!(TimestampMicrosecondType::from_naive_datetime(naive, Some(&tz)).is_none());
2066 assert!(TimestampNanosecondType::from_naive_datetime(naive, Some(&tz)).is_none());
2067 }
2068}