recurring 0.1.5

A recurring event series implementation based on jiff
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

use crate::error::{Error, err};
use core::ops::{Bound, Range, RangeBounds};
use jiff::civil::DateTime;

/// Representation of the time range of a [`Series`][crate::Series].
///
/// This type is similar to [`Range<DateTime>`] but carries additional functionality used by the
/// [`Pattern`][crate::Pattern] trait. There's usually no need for users of this crate to
/// instantiate values of this type unless you want to interact with methods of the `Pattern` trait
/// directly.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct DateTimeRange {
    /// The lower bound of the series (inclusive).
    pub(crate) start: DateTime,
    /// The upper bound of the series (exclusive).
    pub(crate) end: DateTime,
    /// An optional (inclusive) fixpoint used as a starting point for `Pattern` implementations
    /// that are relative to some point in time.
    ///
    /// If this is `None`, these implementations should use `start` as their fixpoint.
    pub(crate) fixpoint: Option<DateTime>,
}

impl DateTimeRange {
    /// Creates a new `DateTimeRange` from a start (inclusive) and an end (exclusive).
    #[inline]
    pub(crate) const fn new(start: DateTime, end: DateTime) -> DateTimeRange {
        DateTimeRange {
            start,
            end,
            fixpoint: None,
        }
    }

    /// Sets the (inclusive) fixpoint for relative recurrence patterns.
    ///
    /// This is used as a starting point for `Pattern` implementations that are relative to some
    /// point in time.
    ///
    /// # Errors
    ///
    /// Returns an error if `fixpoint` is greater than the range start.
    #[inline]
    pub(crate) fn with_fixpoint(mut self, fixpoint: DateTime) -> Result<DateTimeRange, Error> {
        if fixpoint > self.start {
            return Err(err!(
                "fixpoint ({fixpoint}) must be less than or equal to range start ({})",
                self.start
            ));
        }
        self.fixpoint = Some(fixpoint);
        Ok(self)
    }

    /// Intersects `self` with `other`, creating a new `DateTimeRange` of the overlap.
    ///
    /// The returned `DateTimeRange` inherits the fixpoint from `self`.
    ///
    /// # Errors
    ///
    /// Returns an error if the resulting `DateTimeRange` would have a `start >= end`.
    #[inline]
    pub(crate) fn intersect(&self, other: DateTimeRange) -> Result<DateTimeRange, Error> {
        let start = self.start.max(other.start);
        let end = self.end.min(other.end);
        if start >= end {
            return Err(Error::datetime_range("series intersection", start..end));
        }

        DateTimeRange::new(start, end).with_fixpoint(self.fixpoint())
    }

    /// Returns the (inclusive) fixpoint for relative recurrence patterns.
    ///
    /// Unless [`DateTimeRange::with_fixpoint`] was called with a specific value, this returns the
    /// same value as [`DateTimeRange::start`].
    #[inline]
    pub(crate) fn fixpoint(&self) -> DateTime {
        self.fixpoint.unwrap_or(self.start)
    }

    /// The lower bound of the series (inclusive).
    #[inline]
    pub const fn start(&self) -> DateTime {
        self.start
    }

    /// The upper bound of the series (exclusive).
    #[inline]
    pub const fn end(&self) -> DateTime {
        self.end
    }
}

impl RangeBounds<DateTime> for DateTimeRange {
    fn start_bound(&self) -> Bound<&DateTime> {
        Bound::Included(&self.start)
    }

    fn end_bound(&self) -> Bound<&DateTime> {
        Bound::Excluded(&self.end)
    }
}

impl From<DateTimeRange> for Range<DateTime> {
    fn from(range: DateTimeRange) -> Self {
        range.start..range.end
    }
}

impl From<Range<DateTime>> for DateTimeRange {
    fn from(range: Range<DateTime>) -> Self {
        DateTimeRange::new(range.start, range.end)
    }
}