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
mod days_of_month;
mod days_of_week;
mod hours;
mod minutes;
mod months;
mod seconds;
mod years;
pub use self::days_of_month::DaysOfMonth;
pub use self::days_of_week::DaysOfWeek;
pub use self::hours::Hours;
pub use self::minutes::Minutes;
pub use self::months::Months;
pub use self::seconds::Seconds;
pub use self::years::Years;
use crate::error::*;
use crate::ordinal::{Ordinal, OrdinalSet};
use crate::specifier::{RootSpecifier, Specifier};
use std::borrow::Cow;
use std::iter;
/// Methods exposing a schedule's configured ordinals for each individual unit of time.
/// # Example
/// ```
/// use clockwork_cron::{Schedule,TimeUnitSpec};
/// use std::ops::Bound::{Included,Excluded};
/// use std::str::FromStr;
///
/// let expression = "* * * * * * 2015-2044";
/// let schedule = Schedule::from_str(expression).expect("Failed to parse expression.");
///
/// // Membership
/// assert_eq!(true, schedule.years().includes(2031));
/// assert_eq!(false, schedule.years().includes(1969));
///
/// // Number of years specified
/// assert_eq!(30, schedule.years().count());
/// ```
pub trait TimeUnitSpec {
/// Returns true if the provided ordinal was included in the schedule spec for the unit of time
/// being described.
/// # Example
/// ```
/// use clockwork_cron::{Schedule,TimeUnitSpec};
/// use std::str::FromStr;
///
/// let expression = "* * * * * * 2015-2044";
/// let schedule = Schedule::from_str(expression).expect("Failed to parse expression.");
///
/// // Membership
/// assert_eq!(true, schedule.years().includes(2031));
/// assert_eq!(false, schedule.years().includes(2004));
/// ```
fn includes(&self, ordinal: Ordinal) -> bool;
/// Returns the number of ordinals included in the associated schedule
/// # Example
/// ```
/// use clockwork_cron::{Schedule,TimeUnitSpec};
/// use std::str::FromStr;
///
/// let expression = "* * * 1,15 * * *";
/// let schedule = Schedule::from_str(expression).expect("Failed to parse expression.");
///
/// assert_eq!(2, schedule.days_of_month().count());
/// ```
fn count(&self) -> u32;
/// Checks if this TimeUnitSpec is defined as all possibilities (thus created with a '*', '?' or in the case of weekdays '1-7')
/// # Example
/// ```
/// use clockwork_cron::{Schedule,TimeUnitSpec};
/// use std::str::FromStr;
///
/// let expression = "* * * 1,15 * * *";
/// let schedule = Schedule::from_str(expression).expect("Failed to parse expression.");
///
/// assert_eq!(false, schedule.days_of_month().is_all());
/// assert_eq!(true, schedule.months().is_all());
/// ```
fn is_all(&self) -> bool;
}
impl<T> TimeUnitSpec for T
where
T: TimeUnitField,
{
fn includes(&self, ordinal: Ordinal) -> bool {
self.ordinals().contains(&ordinal)
}
fn count(&self) -> u32 {
self.ordinals().len() as u32
}
fn is_all(&self) -> bool {
let max_supported_ordinals = Self::inclusive_max() - Self::inclusive_min() + 1;
self.ordinals().len() == max_supported_ordinals as usize
}
}
pub trait TimeUnitField
where
Self: Sized,
{
fn from_optional_ordinal_set(ordinal_set: Option<OrdinalSet>) -> Self;
fn name() -> Cow<'static, str>;
fn inclusive_min() -> Ordinal;
fn inclusive_max() -> Ordinal;
fn ordinals(&self) -> OrdinalSet;
fn from_ordinal(ordinal: Ordinal) -> Self {
Self::from_ordinal_set(iter::once(ordinal).collect())
}
fn supported_ordinals() -> OrdinalSet {
(Self::inclusive_min()..Self::inclusive_max() + 1).collect()
}
fn all() -> Self {
Self::from_optional_ordinal_set(None)
}
fn from_ordinal_set(ordinal_set: OrdinalSet) -> Self {
Self::from_optional_ordinal_set(Some(ordinal_set))
}
fn ordinal_from_name(name: &str) -> Result<Ordinal, Error> {
Err(ErrorKind::Expression(format!(
"The '{}' field does not support using names. '{}' \
specified.",
Self::name(),
name
))
.into())
}
fn validate_ordinal(ordinal: Ordinal) -> Result<Ordinal, Error> {
//println!("validate_ordinal for {} => {}", Self::name(), ordinal);
match ordinal {
i if i < Self::inclusive_min() => Err(ErrorKind::Expression(format!(
"{} must be greater than or equal to {}. ('{}' \
specified.)",
Self::name(),
Self::inclusive_min(),
i
))
.into()),
i if i > Self::inclusive_max() => Err(ErrorKind::Expression(format!(
"{} must be less than {}. ('{}' specified.)",
Self::name(),
Self::inclusive_max(),
i
))
.into()),
i => Ok(i),
}
}
fn ordinals_from_specifier(specifier: &Specifier) -> Result<OrdinalSet, Error> {
use self::Specifier::*;
//println!("ordinals_from_specifier for {} => {:?}", Self::name(), specifier);
match *specifier {
All => Ok(Self::supported_ordinals().clone()),
Point(ordinal) => Ok((&[ordinal]).iter().cloned().collect()),
Range(start, end) => {
match (Self::validate_ordinal(start), Self::validate_ordinal(end)) {
(Ok(start), Ok(end)) if start <= end => Ok((start..end + 1).collect()),
_ => Err(ErrorKind::Expression(format!(
"Invalid range for {}: {}-{}",
Self::name(),
start,
end
))
.into()),
}
}
NamedRange(ref start_name, ref end_name) => {
let start = Self::ordinal_from_name(start_name)?;
let end = Self::ordinal_from_name(end_name)?;
match (Self::validate_ordinal(start), Self::validate_ordinal(end)) {
(Ok(start), Ok(end)) if start <= end => Ok((start..end + 1).collect()),
_ => Err(ErrorKind::Expression(format!(
"Invalid named range for {}: {}-{}",
Self::name(),
start_name,
end_name
))
.into()),
}
}
}
}
fn ordinals_from_root_specifier(root_specifier: &RootSpecifier) -> Result<OrdinalSet, Error> {
let ordinals = match root_specifier {
RootSpecifier::Specifier(specifier) => Self::ordinals_from_specifier(specifier)?,
RootSpecifier::Period(start, step) => {
let base_set = match start {
// A point prior to a period implies a range whose start is the specified
// point and terminating inclusively with the inclusive max
Specifier::Point(start) => {
let start = Self::validate_ordinal(*start)?;
(start..=Self::inclusive_max()).collect()
}
specifier => Self::ordinals_from_specifier(specifier)?,
};
if *step == 0 {
return Err(ErrorKind::Expression(format!("step cannot be 0")).into());
}
base_set.into_iter().step_by(*step as usize).collect()
}
RootSpecifier::NamedPoint(ref name) => (&[Self::ordinal_from_name(name)?])
.iter()
.cloned()
.collect::<OrdinalSet>(),
};
Ok(ordinals)
}
}