periodical 0.3.0

Management of all kinds of time intervals, use it to manage schedules, find overlaps, and more!
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
//! Interval cutting
//!
//! Cutting an interval results in two split intervals, if the position of the
//! cut is within the interval, that is. The type of gap created by the cut is
//! chosen by the given [`CutType`], which describes the new inclusivities
//! of the now-split intervals for where the cut has occurred.
//!
//! Cutting an interval at a start/end will work only if the actual bound is
//! inclusive and the [`CutType`] also defines that this part of the cut should
//! be inclusive, resulting in an interval representing a single point in time.
//! If those requirements are not met, the operation will result in
//! [`CutResult::Uncut`], as cutting would create an illegal interval.
//!
//! If you are looking to make a "cut" with a non-zero duration gap,
//! see [`Differentiable`](crate::intervals::ops::set_ops::Differentiable).
//!
//! # Examples
//!
//! ## Cutting an interval in two
//!
//! ```
//! # use std::error::Error;
//! # use jiff::Zoned;
//! # use periodical::intervals::absolute::{AbsBoundPair, AbsFiniteBoundPos};
//! # use periodical::intervals::meta::BoundInclusivity;
//! # use periodical::intervals::ops::cut::{CutResult, Cuttable, CutType};
//! let interval = AbsBoundPair::new(
//!     AbsFiniteBoundPos::new(
//!         "2025-01-01 08:00:00[Europe/Oslo]"
//!             .parse::<Zoned>()?
//!             .timestamp(),
//!     )
//!     .to_start_bound(),
//!     AbsFiniteBoundPos::new(
//!         "2025-01-01 16:00:00[Europe/Oslo]"
//!             .parse::<Zoned>()?
//!             .timestamp(),
//!     )
//!     .to_end_bound(),
//! );
//!
//! let cut_type = CutType::new(BoundInclusivity::Exclusive, BoundInclusivity::Exclusive);
//! let at = "2025-01-01 12:00:00[Europe/Oslo]"
//!     .parse::<Zoned>()?
//!     .timestamp();
//!
//! assert_eq!(
//!     interval.cut_at(at, cut_type),
//!     CutResult::Cut(
//!         AbsBoundPair::new(
//!             AbsFiniteBoundPos::new(
//!                 "2025-01-01 08:00:00[Europe/Oslo]"
//!                     .parse::<Zoned>()?
//!                     .timestamp()
//!             )
//!             .to_start_bound(),
//!             AbsFiniteBoundPos::new_with_incl(
//!                 "2025-01-01 12:00:00[Europe/Oslo]"
//!                     .parse::<Zoned>()?
//!                     .timestamp(),
//!                 BoundInclusivity::Exclusive,
//!             )
//!             .to_end_bound(),
//!         ),
//!         AbsBoundPair::new(
//!             AbsFiniteBoundPos::new_with_incl(
//!                 "2025-01-01 12:00:00[Europe/Oslo]"
//!                     .parse::<Zoned>()?
//!                     .timestamp(),
//!                 BoundInclusivity::Exclusive,
//!             )
//!             .to_start_bound(),
//!             AbsFiniteBoundPos::new(
//!                 "2025-01-01 16:00:00[Europe/Oslo]"
//!                     .parse::<Zoned>()?
//!                     .timestamp(),
//!             )
//!             .to_end_bound(),
//!         ),
//!     ),
//! );
//! # Ok::<(), Box<dyn Error>>(())
//! ```
//!
//! ## Cutting at one end
//!
//! ```
//! # use std::error::Error;
//! # use jiff::Zoned;
//! # use periodical::intervals::absolute::{AbsBoundPair, AbsFiniteBoundPos};
//! # use periodical::intervals::meta::BoundInclusivity;
//! # use periodical::intervals::ops::cut::{CutResult, Cuttable, CutType};
//! let interval = AbsBoundPair::new(
//!     AbsFiniteBoundPos::new(
//!         "2025-01-01 08:00:00[Europe/Oslo]"
//!             .parse::<Zoned>()?
//!             .timestamp(),
//!     )
//!     .to_start_bound(),
//!     AbsFiniteBoundPos::new(
//!         "2025-01-01 16:00:00[Europe/Oslo]"
//!             .parse::<Zoned>()?
//!             .timestamp(),
//!     )
//!     .to_end_bound(),
//! );
//!
//! let cut_type = CutType::new(BoundInclusivity::Exclusive, BoundInclusivity::Inclusive);
//! let at = "2025-01-01 16:00:00[Europe/Oslo]"
//!     .parse::<Zoned>()?
//!     .timestamp();
//!
//! assert_eq!(
//!     interval.cut_at(at, cut_type),
//!     CutResult::Cut(
//!         AbsBoundPair::new(
//!             AbsFiniteBoundPos::new(
//!                 "2025-01-01 08:00:00[Europe/Oslo]"
//!                     .parse::<Zoned>()?
//!                     .timestamp()
//!             )
//!             .to_start_bound(),
//!             AbsFiniteBoundPos::new_with_incl(
//!                 "2025-01-01 16:00:00[Europe/Oslo]"
//!                     .parse::<Zoned>()?
//!                     .timestamp(),
//!                 BoundInclusivity::Exclusive,
//!             )
//!             .to_end_bound(),
//!         ),
//!         AbsBoundPair::new(
//!             AbsFiniteBoundPos::new(
//!                 "2025-01-01 16:00:00[Europe/Oslo]"
//!                     .parse::<Zoned>()?
//!                     .timestamp(),
//!             )
//!             .to_start_bound(),
//!             AbsFiniteBoundPos::new(
//!                 "2025-01-01 16:00:00[Europe/Oslo]"
//!                     .parse::<Zoned>()?
//!                     .timestamp(),
//!             )
//!             .to_end_bound(),
//!         ),
//!     ),
//! );
//! # Ok::<(), Box<dyn Error>>(())
//! ```
//!
//! ## Trying to cut a bound into an illegal interval
//!
//! ```
//! # use std::error::Error;
//! # use jiff::Zoned;
//! # use periodical::intervals::absolute::{AbsBoundPair, AbsFiniteBoundPos};
//! # use periodical::intervals::meta::BoundInclusivity;
//! # use periodical::intervals::ops::cut::{CutResult, Cuttable, CutType};
//! let interval = AbsBoundPair::new(
//!     AbsFiniteBoundPos::new(
//!         "2025-01-01 08:00:00[Europe/Oslo]"
//!             .parse::<Zoned>()?
//!             .timestamp(),
//!     )
//!     .to_start_bound(),
//!     AbsFiniteBoundPos::new(
//!         "2025-01-01 16:00:00[Europe/Oslo]"
//!             .parse::<Zoned>()?
//!             .timestamp(),
//!     )
//!     .to_end_bound(),
//! );
//!
//! let cut_type = CutType::new(BoundInclusivity::Exclusive, BoundInclusivity::Exclusive);
//! let at = "2025-01-01 16:00:00[Europe/Oslo]"
//!     .parse::<Zoned>()?
//!     .timestamp();
//!
//! assert_eq!(interval.cut_at(at, cut_type), CutResult::Uncut);
//! # Ok::<(), Box<dyn Error>>(())
//! ```

#[cfg(feature = "arbitrary")]
use arbitrary::Arbitrary;
use jiff::{SignedDuration, Timestamp};
#[cfg(feature = "serde")]
use serde::{Deserialize, Serialize};

use super::point_containment::CanPositionPointContainment;
use crate::intervals::absolute::{
    AbsBoundPair,
    AbsFiniteBoundPos,
    AbsInterval,
    BoundedAbsInterval,
    EmptiableAbsBoundPair,
    EmptiableAbsInterval,
    HalfBoundedAbsInterval,
    HasAbsBoundPair,
    HasEmptiableAbsBoundPair,
    check_abs_start_end_bounds_for_interval_creation,
};
use crate::intervals::meta::BoundInclusivity;
use crate::intervals::relative::{
    BoundedRelInterval,
    EmptiableRelBoundPair,
    EmptiableRelInterval,
    HalfBoundedRelInterval,
    HasEmptiableRelBoundPair,
    HasRelBoundPair,
    RelBoundPair,
    RelFiniteBoundPos,
    RelInterval,
    check_rel_start_end_bounds_for_interval_creation,
};
use crate::intervals::special::{EmptyInterval, UnboundedInterval};

/// Cut type
///
/// Describes what [`BoundInclusivity`]s should be put at the place of the cut.
///
/// The first element describes the [`BoundInclusivity`] to put on the past part
/// of the cut, the second element describes the [`BoundInclusivity`] to put on
/// the future part of the cut.
///
/// For example, `CutType::new(BoundInclusivity::Inclusive, BoundInclusivity::Exclusive)`,
/// will cut an interval such that the first cut
/// part will end with an inclusive bound at the position
/// given to [`Cuttable::cut_at`], and the second part will start with an
/// exclusive bound at the same position.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Default)]
#[cfg_attr(feature = "arbitrary", derive(Arbitrary))]
#[cfg_attr(feature = "serde", derive(Deserialize, Serialize))]
pub struct CutType(BoundInclusivity, BoundInclusivity);

impl CutType {
    /// Creates a new [`CutType`]
    #[must_use]
    pub fn new(past_inclusivity: BoundInclusivity, future_inclusivity: BoundInclusivity) -> Self {
        CutType(past_inclusivity, future_inclusivity)
    }

    /// Returns the [`BoundInclusivity`] for the past side
    ///
    /// # Examples
    ///
    /// ```
    /// # use periodical::intervals::meta::BoundInclusivity;
    /// # use periodical::intervals::ops::cut::CutType;
    /// let cut_type = CutType::new(BoundInclusivity::Inclusive, BoundInclusivity::Exclusive);
    ///
    /// assert_eq!(
    ///     cut_type.past_bound_inclusivity(),
    ///     BoundInclusivity::Inclusive
    /// );
    /// ```
    #[must_use]
    pub fn past_bound_inclusivity(&self) -> BoundInclusivity {
        self.0
    }

    /// Returns the [`BoundInclusivity`] for the future side
    ///
    /// # Examples
    ///
    /// ```
    /// # use periodical::intervals::meta::BoundInclusivity;
    /// # use periodical::intervals::ops::cut::CutType;
    /// let cut_type = CutType::new(BoundInclusivity::Inclusive, BoundInclusivity::Exclusive);
    ///
    /// assert_eq!(
    ///     cut_type.future_bound_inclusivity(),
    ///     BoundInclusivity::Exclusive
    /// );
    /// ```
    #[must_use]
    pub fn future_bound_inclusivity(&self) -> BoundInclusivity {
        self.1
    }

    /// Returns a [`CutType`] with opposite inclusivities
    ///
    /// # Examples
    ///
    /// ```
    /// # use periodical::intervals::meta::BoundInclusivity;
    /// # use periodical::intervals::ops::cut::CutType;
    /// let cut_type = CutType::new(BoundInclusivity::Inclusive, BoundInclusivity::Exclusive);
    ///
    /// assert_eq!(
    ///     cut_type.opposite(),
    ///     CutType::new(BoundInclusivity::Exclusive, BoundInclusivity::Inclusive),
    /// );
    /// ```
    #[must_use]
    pub fn opposite(&self) -> Self {
        CutType::new(self.0.opposite(), self.1.opposite())
    }
}

impl From<(BoundInclusivity, BoundInclusivity)> for CutType {
    fn from((past_inclusivity, future_inclusivity): (BoundInclusivity, BoundInclusivity)) -> Self {
        CutType::new(past_inclusivity, future_inclusivity)
    }
}

/// Result of a [cut](Cuttable)
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
#[cfg_attr(feature = "serde", derive(Deserialize, Serialize))]
pub enum CutResult<T> {
    /// Uncut result
    ///
    /// The cutting point is either outside the given interval, or would have
    /// created an illegal interval.
    Uncut,
    /// Cut result
    ///
    /// The cut was successful, the variant contains the two cut parts.
    ///
    /// The cut parts are always in chronological order, since a single interval
    /// can't be described backwards.
    Cut(T, T),
}

impl<T> CutResult<T> {
    /// Whether it is of the [`Uncut`](CutResult::Uncut) variant
    ///
    /// # Examples
    ///
    /// ```
    /// # use periodical::intervals::ops::cut::CutResult;
    /// assert!(CutResult::<()>::Uncut.is_uncut());
    /// assert!(!CutResult::<()>::Cut((), ()).is_uncut());
    /// ```
    #[must_use]
    pub fn is_uncut(&self) -> bool {
        matches!(self, CutResult::Uncut)
    }

    /// Whether it is of the [`Cut`](CutResult::Cut) variant
    ///
    /// # Examples
    ///
    /// ```
    /// # use periodical::intervals::ops::cut::CutResult;
    /// assert!(CutResult::<()>::Cut((), ()).is_cut());
    /// assert!(!CutResult::<()>::Uncut.is_cut());
    /// ```
    #[must_use]
    pub fn is_cut(&self) -> bool {
        matches!(self, CutResult::Cut(..))
    }

    /// Returns the content of the [`Cut`](CutResult::Cut) variant
    ///
    /// Consumes `self` and puts the content of the [`Cut`](CutResult::Cut)
    /// variant in an [`Option`]. If instead `self` is another variant, the
    /// method returns [`None`].
    ///
    /// # Examples
    ///
    /// ```
    /// # use periodical::intervals::ops::cut::CutResult;
    /// assert_eq!(CutResult::<u8>::Cut(10, 20).cut(), Some((10, 20)));
    /// assert_eq!(CutResult::<u8>::Uncut.cut(), None);
    /// ```
    #[must_use]
    pub fn cut(self) -> Option<(T, T)> {
        match self {
            Self::Uncut => None,
            Self::Cut(a, b) => Some((a, b)),
        }
    }

    /// Maps the contents of the [`Cut`](CutResult::Cut) variant
    ///
    /// # Examples
    ///
    /// ```
    /// # use periodical::intervals::ops::cut::CutResult;
    /// assert_eq!(
    ///     CutResult::<u8>::Cut(10, 20).map_cut(|x, y| (x * 2, y * 3)),
    ///     CutResult::<u8>::Cut(20, 60),
    /// );
    /// ```
    #[must_use]
    pub fn map_cut<F, U>(self, mut f: F) -> CutResult<U>
    where
        F: FnMut(T, T) -> (U, U),
    {
        match self {
            Self::Uncut => CutResult::Uncut,
            Self::Cut(c1, c2) => {
                let mapped_cut = (f)(c1, c2);
                CutResult::Cut(mapped_cut.0, mapped_cut.1)
            },
        }
    }
}

/// Capacity to cut an interval
///
/// The generic type parameter `P` corresponds to the type used for positioning
/// the cut.
///
/// Cutting an interval results in two split intervals, if the position of the
/// cut is within the interval, that is. The type of gap created by the cut is
/// chosen by the given [`CutType`], which describes the new inclusivities
/// of the now-split intervals for where the cut has occurred.
///
/// Cutting an interval at a start/end point will work only if the actual bound
/// is inclusive and the [`CutType`] also defines that this part of the cut
/// should be inclusive, resulting in an interval representing a single point in
/// time. If those requirements are not met, the operation will result in
/// [`CutResult::Uncut`], as cutting would create an illegal interval.
///
/// If you are looking to make a "cut" with a non-zero duration gap,
/// see [`Differentiable`](crate::intervals::ops::set_ops::Differentiable).
///
/// # Examples
///
/// ## Cutting an interval in two
///
/// ```
/// # use std::error::Error;
/// # use jiff::Zoned;
/// # use periodical::intervals::absolute::{AbsBoundPair, AbsFiniteBoundPos};
/// # use periodical::intervals::meta::BoundInclusivity;
/// # use periodical::intervals::ops::cut::{CutResult, Cuttable, CutType};
/// let interval = AbsBoundPair::new(
///     AbsFiniteBoundPos::new(
///         "2025-01-01 08:00:00[Europe/Oslo]"
///             .parse::<Zoned>()?
///             .timestamp(),
///     )
///     .to_start_bound(),
///     AbsFiniteBoundPos::new(
///         "2025-01-01 16:00:00[Europe/Oslo]"
///             .parse::<Zoned>()?
///             .timestamp(),
///     )
///     .to_end_bound(),
/// );
///
/// let cut_type = CutType::new(BoundInclusivity::Exclusive, BoundInclusivity::Exclusive);
/// let at = "2025-01-01 12:00:00[Europe/Oslo]"
///     .parse::<Zoned>()?
///     .timestamp();
///
/// assert_eq!(
///     interval.cut_at(at, cut_type),
///     CutResult::Cut(
///         AbsBoundPair::new(
///             AbsFiniteBoundPos::new(
///                 "2025-01-01 08:00:00[Europe/Oslo]"
///                     .parse::<Zoned>()?
///                     .timestamp()
///             )
///             .to_start_bound(),
///             AbsFiniteBoundPos::new_with_incl(
///                 "2025-01-01 12:00:00[Europe/Oslo]"
///                     .parse::<Zoned>()?
///                     .timestamp(),
///                 BoundInclusivity::Exclusive,
///             )
///             .to_end_bound(),
///         ),
///         AbsBoundPair::new(
///             AbsFiniteBoundPos::new_with_incl(
///                 "2025-01-01 12:00:00[Europe/Oslo]"
///                     .parse::<Zoned>()?
///                     .timestamp(),
///                 BoundInclusivity::Exclusive,
///             )
///             .to_start_bound(),
///             AbsFiniteBoundPos::new(
///                 "2025-01-01 16:00:00[Europe/Oslo]"
///                     .parse::<Zoned>()?
///                     .timestamp(),
///             )
///             .to_end_bound(),
///         ),
///     ),
/// );
/// # Ok::<(), Box<dyn Error>>(())
/// ```
///
/// ## Cutting at one end
///
/// ```
/// # use std::error::Error;
/// # use jiff::Zoned;
/// # use periodical::intervals::absolute::{AbsBoundPair, AbsFiniteBoundPos};
/// # use periodical::intervals::meta::BoundInclusivity;
/// # use periodical::intervals::ops::cut::{CutResult, Cuttable, CutType};
/// let interval = AbsBoundPair::new(
///     AbsFiniteBoundPos::new(
///         "2025-01-01 08:00:00[Europe/Oslo]"
///             .parse::<Zoned>()?
///             .timestamp(),
///     )
///     .to_start_bound(),
///     AbsFiniteBoundPos::new(
///         "2025-01-01 16:00:00[Europe/Oslo]"
///             .parse::<Zoned>()?
///             .timestamp(),
///     )
///     .to_end_bound(),
/// );
///
/// let cut_type = CutType::new(BoundInclusivity::Exclusive, BoundInclusivity::Inclusive);
/// let at = "2025-01-01 16:00:00[Europe/Oslo]"
///     .parse::<Zoned>()?
///     .timestamp();
///
/// assert_eq!(
///     interval.cut_at(at, cut_type),
///     CutResult::Cut(
///         AbsBoundPair::new(
///             AbsFiniteBoundPos::new(
///                 "2025-01-01 08:00:00[Europe/Oslo]"
///                     .parse::<Zoned>()?
///                     .timestamp()
///             )
///             .to_start_bound(),
///             AbsFiniteBoundPos::new_with_incl(
///                 "2025-01-01 16:00:00[Europe/Oslo]"
///                     .parse::<Zoned>()?
///                     .timestamp(),
///                 BoundInclusivity::Exclusive,
///             )
///             .to_end_bound(),
///         ),
///         AbsBoundPair::new(
///             AbsFiniteBoundPos::new(
///                 "2025-01-01 16:00:00[Europe/Oslo]"
///                     .parse::<Zoned>()?
///                     .timestamp(),
///             )
///             .to_start_bound(),
///             AbsFiniteBoundPos::new(
///                 "2025-01-01 16:00:00[Europe/Oslo]"
///                     .parse::<Zoned>()?
///                     .timestamp(),
///             )
///             .to_end_bound(),
///         ),
///     ),
/// );
/// # Ok::<(), Box<dyn Error>>(())
/// ```
///
/// ## Trying to cut a bound into an illegal interval
///
/// ```
/// # use std::error::Error;
/// # use jiff::Zoned;
/// # use periodical::intervals::absolute::{AbsBoundPair, AbsFiniteBoundPos};
/// # use periodical::intervals::meta::BoundInclusivity;
/// # use periodical::intervals::ops::cut::{CutResult, Cuttable, CutType};
/// let interval = AbsBoundPair::new(
///     AbsFiniteBoundPos::new(
///         "2025-01-01 08:00:00[Europe/Oslo]"
///             .parse::<Zoned>()?
///             .timestamp(),
///     )
///     .to_start_bound(),
///     AbsFiniteBoundPos::new(
///         "2025-01-01 16:00:00[Europe/Oslo]"
///             .parse::<Zoned>()?
///             .timestamp(),
///     )
///     .to_end_bound(),
/// );
///
/// let cut_type = CutType::new(BoundInclusivity::Exclusive, BoundInclusivity::Exclusive);
/// let at = "2025-01-01 16:00:00[Europe/Oslo]"
///     .parse::<Zoned>()?
///     .timestamp();
///
/// assert_eq!(interval.cut_at(at, cut_type), CutResult::Uncut,);
/// # Ok::<(), Box<dyn Error>>(())
/// ```
pub trait Cuttable<P> {
    /// Output type
    type Output;

    /// Cuts the interval at the given position
    ///
    /// # Examples
    ///
    /// ```
    /// # use std::error::Error;
    /// # use jiff::Zoned;
    /// # use periodical::intervals::absolute::{AbsBoundPair, AbsFiniteBoundPos};
    /// # use periodical::intervals::meta::BoundInclusivity;
    /// # use periodical::intervals::ops::cut::{CutResult, Cuttable, CutType};
    /// let interval = AbsBoundPair::new(
    ///     AbsFiniteBoundPos::new(
    ///         "2025-01-01 08:00:00[Europe/Oslo]"
    ///             .parse::<Zoned>()?
    ///             .timestamp(),
    ///     )
    ///     .to_start_bound(),
    ///     AbsFiniteBoundPos::new(
    ///         "2025-01-01 16:00:00[Europe/Oslo]"
    ///             .parse::<Zoned>()?
    ///             .timestamp(),
    ///     )
    ///     .to_end_bound(),
    /// );
    ///
    /// let cut_type = CutType::new(BoundInclusivity::Exclusive, BoundInclusivity::Exclusive);
    /// let at = "2025-01-01 12:00:00[Europe/Oslo]"
    ///     .parse::<Zoned>()?
    ///     .timestamp();
    ///
    /// assert_eq!(
    ///     interval.cut_at(at, cut_type),
    ///     CutResult::Cut(
    ///         AbsBoundPair::new(
    ///             AbsFiniteBoundPos::new(
    ///                 "2025-01-01 08:00:00[Europe/Oslo]"
    ///                     .parse::<Zoned>()?
    ///                     .timestamp()
    ///             )
    ///             .to_start_bound(),
    ///             AbsFiniteBoundPos::new_with_incl(
    ///                 "2025-01-01 12:00:00[Europe/Oslo]"
    ///                     .parse::<Zoned>()?
    ///                     .timestamp(),
    ///                 BoundInclusivity::Exclusive,
    ///             )
    ///             .to_end_bound(),
    ///         ),
    ///         AbsBoundPair::new(
    ///             AbsFiniteBoundPos::new_with_incl(
    ///                 "2025-01-01 12:00:00[Europe/Oslo]"
    ///                     .parse::<Zoned>()?
    ///                     .timestamp(),
    ///                 BoundInclusivity::Exclusive,
    ///             )
    ///             .to_start_bound(),
    ///             AbsFiniteBoundPos::new(
    ///                 "2025-01-01 16:00:00[Europe/Oslo]"
    ///                     .parse::<Zoned>()?
    ///                     .timestamp(),
    ///             )
    ///             .to_end_bound(),
    ///         ),
    ///     ),
    /// );
    /// # Ok::<(), Box<dyn Error>>(())
    /// ```
    fn cut_at(&self, position: P, cut_type: CutType) -> CutResult<Self::Output>;
}

impl Cuttable<Timestamp> for AbsBoundPair {
    type Output = Self;

    fn cut_at(&self, position: Timestamp, cut_type: CutType) -> CutResult<Self::Output> {
        cut_abs_bound_pair(self, position, cut_type)
    }
}

impl Cuttable<Timestamp> for EmptiableAbsBoundPair {
    type Output = Self;

    fn cut_at(&self, position: Timestamp, cut_type: CutType) -> CutResult<Self::Output> {
        cut_emptiable_abs_bound_pair(self, position, cut_type)
    }
}

impl Cuttable<Timestamp> for AbsInterval {
    type Output = Self;

    fn cut_at(&self, position: Timestamp, cut_type: CutType) -> CutResult<Self::Output> {
        cut_abs_bound_pair(&self.abs_bound_pair(), position, cut_type)
            .map_cut(|c1, c2| (c1.to_interval(), c2.to_interval()))
    }
}

impl Cuttable<Timestamp> for EmptiableAbsInterval {
    type Output = Self;

    fn cut_at(&self, position: Timestamp, cut_type: CutType) -> CutResult<Self::Output> {
        cut_emptiable_abs_bound_pair(&self.emptiable_abs_bound_pair(), position, cut_type)
            .map_cut(|c1, c2| (c1.to_emptiable_interval(), c2.to_emptiable_interval()))
    }
}

impl Cuttable<Timestamp> for BoundedAbsInterval {
    type Output = Self;

    fn cut_at(&self, position: Timestamp, cut_type: CutType) -> CutResult<Self::Output> {
        cut_bounded_abs_interval(self, position, cut_type)
    }
}

impl Cuttable<Timestamp> for HalfBoundedAbsInterval {
    type Output = AbsInterval;

    fn cut_at(&self, position: Timestamp, cut_type: CutType) -> CutResult<Self::Output> {
        cut_abs_bound_pair(&self.abs_bound_pair(), position, cut_type)
            .map_cut(|c1, c2| (c1.to_interval(), c2.to_interval()))
    }
}

impl Cuttable<SignedDuration> for RelBoundPair {
    type Output = Self;

    fn cut_at(&self, position: SignedDuration, cut_type: CutType) -> CutResult<Self::Output> {
        cut_rel_bound_pair(self, position, cut_type)
    }
}

impl Cuttable<SignedDuration> for EmptiableRelBoundPair {
    type Output = Self;

    fn cut_at(&self, position: SignedDuration, cut_type: CutType) -> CutResult<Self::Output> {
        cut_emptiable_rel_bound_pair(self, position, cut_type)
    }
}

impl Cuttable<SignedDuration> for RelInterval {
    type Output = Self;

    fn cut_at(&self, position: SignedDuration, cut_type: CutType) -> CutResult<Self::Output> {
        cut_rel_bound_pair(&self.rel_bound_pair(), position, cut_type)
            .map_cut(|c1, c2| (c1.to_interval(), c2.to_interval()))
    }
}

impl Cuttable<SignedDuration> for EmptiableRelInterval {
    type Output = Self;

    fn cut_at(&self, position: SignedDuration, cut_type: CutType) -> CutResult<Self::Output> {
        cut_emptiable_rel_bound_pair(&self.emptiable_rel_bound_pair(), position, cut_type)
            .map_cut(|c1, c2| (c1.to_emptiable_interval(), c2.to_emptiable_interval()))
    }
}

impl Cuttable<SignedDuration> for BoundedRelInterval {
    type Output = Self;

    fn cut_at(&self, position: SignedDuration, cut_type: CutType) -> CutResult<Self::Output> {
        cut_bounded_rel_interval(self, position, cut_type)
    }
}

impl Cuttable<SignedDuration> for HalfBoundedRelInterval {
    type Output = RelInterval;

    fn cut_at(&self, position: SignedDuration, cut_type: CutType) -> CutResult<Self::Output> {
        cut_rel_bound_pair(&self.rel_bound_pair(), position, cut_type)
            .map_cut(|c1, c2| (c1.to_interval(), c2.to_interval()))
    }
}

impl Cuttable<Timestamp> for UnboundedInterval {
    type Output = AbsInterval;

    fn cut_at(&self, position: Timestamp, cut_type: CutType) -> CutResult<Self::Output> {
        cut_abs_bound_pair(&self.abs_bound_pair(), position, cut_type)
            .map_cut(|c1, c2| (c1.to_interval(), c2.to_interval()))
    }
}

impl Cuttable<SignedDuration> for UnboundedInterval {
    type Output = RelInterval;

    fn cut_at(&self, position: SignedDuration, cut_type: CutType) -> CutResult<Self::Output> {
        cut_rel_bound_pair(&self.rel_bound_pair(), position, cut_type)
            .map_cut(|c1, c2| (c1.to_interval(), c2.to_interval()))
    }
}

impl Cuttable<Timestamp> for EmptyInterval {
    type Output = ();

    fn cut_at(&self, _position: Timestamp, _cut_type: CutType) -> CutResult<Self::Output> {
        CutResult::Uncut
    }
}

impl Cuttable<SignedDuration> for EmptyInterval {
    type Output = ();

    fn cut_at(&self, _position: SignedDuration, _cut_type: CutType) -> CutResult<Self::Output> {
        CutResult::Uncut
    }
}

/// Cuts an [`AbsBoundPair`] with a [`Timestamp`]
///
/// See [module documentation](self) for more info.
#[must_use]
pub fn cut_abs_bound_pair(bounds: &AbsBoundPair, at: Timestamp, cut_type: CutType) -> CutResult<AbsBoundPair> {
    if !bounds.simple_contains_point(at) {
        return CutResult::Uncut;
    }

    let past_cut_end = AbsFiniteBoundPos::new_with_incl(at, cut_type.past_bound_inclusivity()).to_end_bound();
    let future_cut_start = AbsFiniteBoundPos::new_with_incl(at, cut_type.future_bound_inclusivity()).to_start_bound();

    if check_abs_start_end_bounds_for_interval_creation(&bounds.start(), &past_cut_end).is_err()
        || check_abs_start_end_bounds_for_interval_creation(&future_cut_start, &bounds.end()).is_err()
    {
        return CutResult::Uncut;
    }

    let mut past_split = bounds.clone();
    let mut future_split = bounds.clone();

    past_split.set_end(AbsFiniteBoundPos::new_with_incl(at, cut_type.past_bound_inclusivity()).to_end_bound());

    future_split.set_start(AbsFiniteBoundPos::new_with_incl(at, cut_type.future_bound_inclusivity()).to_start_bound());

    CutResult::Cut(past_split, future_split)
}

/// Cuts an [`EmptiableAbsBoundPair`] with a [`Timestamp`]
///
/// See [module documentation](self) for more info.
#[must_use]
pub fn cut_emptiable_abs_bound_pair(
    bounds: &EmptiableAbsBoundPair,
    at: Timestamp,
    cut_type: CutType,
) -> CutResult<EmptiableAbsBoundPair> {
    let EmptiableAbsBoundPair::Bound(non_empty_bounds) = bounds else {
        // Empty bounds can't be cut
        return CutResult::Uncut;
    };

    cut_abs_bound_pair(non_empty_bounds, at, cut_type)
        .map_cut(|c1, c2| (EmptiableAbsBoundPair::from(c1), EmptiableAbsBoundPair::from(c2)))
}

/// Cuts a [`BoundedAbsInterval`] with a [`Timestamp`]
///
/// See [module documentation](self) for more info.
#[must_use]
pub fn cut_bounded_abs_interval(
    interval: &BoundedAbsInterval,
    at: Timestamp,
    cut_type: CutType,
) -> CutResult<BoundedAbsInterval> {
    if !interval.simple_contains_point(at) {
        return CutResult::Uncut;
    }

    let past_cut_end = AbsFiniteBoundPos::new_with_incl(at, cut_type.past_bound_inclusivity()).to_end_bound();

    let future_cut_start = AbsFiniteBoundPos::new_with_incl(at, cut_type.future_bound_inclusivity()).to_start_bound();

    if check_abs_start_end_bounds_for_interval_creation(&interval.abs_start(), &past_cut_end).is_err()
        || check_abs_start_end_bounds_for_interval_creation(&future_cut_start, &interval.abs_end()).is_err()
    {
        return CutResult::Uncut;
    }

    let past_split = BoundedAbsInterval::unchecked_from_times_incl(
        interval.start_time(),
        interval.start_inclusivity(),
        at,
        cut_type.past_bound_inclusivity(),
    );

    let future_split = BoundedAbsInterval::unchecked_from_times_incl(
        at,
        cut_type.future_bound_inclusivity(),
        interval.end_time(),
        interval.end_inclusivity(),
    );

    CutResult::Cut(past_split, future_split)
}

/// Cuts a [`RelBoundPair`] with a [`Timestamp`]
///
/// See [module documentation](self) for more info.
#[must_use]
pub fn cut_rel_bound_pair(bounds: &RelBoundPair, at: SignedDuration, cut_type: CutType) -> CutResult<RelBoundPair> {
    if !bounds.simple_contains_point(at) {
        return CutResult::Uncut;
    }

    let past_cut_end = RelFiniteBoundPos::new_with_incl(at, cut_type.past_bound_inclusivity()).to_end_bound();
    let future_cut_start = RelFiniteBoundPos::new_with_incl(at, cut_type.future_bound_inclusivity()).to_start_bound();

    if check_rel_start_end_bounds_for_interval_creation(&bounds.start(), &past_cut_end).is_err()
        || check_rel_start_end_bounds_for_interval_creation(&future_cut_start, &bounds.end()).is_err()
    {
        return CutResult::Uncut;
    }

    let mut past_split = bounds.clone();
    let mut future_split = bounds.clone();

    past_split.set_end(RelFiniteBoundPos::new_with_incl(at, cut_type.past_bound_inclusivity()).to_end_bound());

    future_split.set_start(RelFiniteBoundPos::new_with_incl(at, cut_type.future_bound_inclusivity()).to_start_bound());

    CutResult::Cut(past_split, future_split)
}

/// Cuts an [`EmptiableRelBoundPair`] with a [`Timestamp`]
///
/// See [module documentation](self) for more info.
#[must_use]
pub fn cut_emptiable_rel_bound_pair(
    bounds: &EmptiableRelBoundPair,
    at: SignedDuration,
    cut_type: CutType,
) -> CutResult<EmptiableRelBoundPair> {
    let EmptiableRelBoundPair::Bound(non_empty_bounds) = bounds else {
        // Empty bounds can't be cut
        return CutResult::Uncut;
    };

    cut_rel_bound_pair(non_empty_bounds, at, cut_type)
        .map_cut(|c1, c2| (EmptiableRelBoundPair::from(c1), EmptiableRelBoundPair::from(c2)))
}

/// Cuts a [`BoundedRelInterval`] with a [`Timestamp`]
///
/// See [module documentation](self) for more info.
#[must_use]
pub fn cut_bounded_rel_interval(
    interval: &BoundedRelInterval,
    at: SignedDuration,
    cut_type: CutType,
) -> CutResult<BoundedRelInterval> {
    if !interval.simple_contains_point(at) {
        return CutResult::Uncut;
    }

    let past_cut_end = RelFiniteBoundPos::new_with_incl(at, cut_type.past_bound_inclusivity()).to_end_bound();

    let future_cut_start = RelFiniteBoundPos::new_with_incl(at, cut_type.future_bound_inclusivity()).to_start_bound();

    if check_rel_start_end_bounds_for_interval_creation(&interval.rel_start(), &past_cut_end).is_err()
        || check_rel_start_end_bounds_for_interval_creation(&future_cut_start, &interval.rel_end()).is_err()
    {
        return CutResult::Uncut;
    }

    let past_split = BoundedRelInterval::unchecked_from_offsets_incl(
        interval.start_offset(),
        interval.start_inclusivity(),
        at,
        cut_type.past_bound_inclusivity(),
    );

    let future_split = BoundedRelInterval::unchecked_from_offsets_incl(
        at,
        cut_type.future_bound_inclusivity(),
        interval.end_offset(),
        interval.end_inclusivity(),
    );

    CutResult::Cut(past_split, future_split)
}