skedge 0.3.0

Ergonomic single-process job scheduling for Rust programs.
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

//! This module defines the error type and Result alias.

use crate::Unit;
use jiff::civil::Weekday;
use thiserror::Error;

#[derive(Debug, Error)]
pub enum Error {
	#[error("Tried to reference this job's inner subroutine but failed")]
	CallableUnreachable,
	#[error("Use {0}s() instead of {0}()")]
	Interval(Unit),
	#[error("Cannot set {0}s mode, already using {1}s")]
	Unit(Unit, Unit),
	#[error("Latest val is greater than interval val")]
	InvalidInterval,
	#[error("Invalid unit (valid units are `days`, `hours`, and `minutes`)")]
	InvalidUnit,
	#[error("Invalid hour ({0} is not between 0 and 23)")]
	InvalidHour(i8),
	#[error("Invalid time format for daily job (valid format is HH:MM(:SS)?)")]
	InvalidDailyAtStr,
	#[error("Invalid time format for hourly job (valid format is (MM)?:SS)")]
	InvalidHourlyAtStr,
	#[error("Invalid time format for minutely job (valid format is :SS)")]
	InvalidMinuteAtStr,
	#[error("Invalid string format for until()")]
	InvalidUntilStr,
	#[error("Cannot schedule a job to run until a time in the past")]
	InvalidUntilTime,
	#[error("Attempted to reference the next run time but failed")]
	NextRunUnreachable,
	#[error("Attempted to reference the last run time but failed")]
	LastRunUnreachable,
	#[error("Attempted to reference the period but failed")]
	PeriodUnreachable,
	#[error("Attempted to reference the period but failed")]
	UnitUnreachable,
	#[error("Attempted to use a start day for a unit other than `weeks`")]
	StartDayError,
	#[error("{0}")]
	Jiff(#[from] jiff::Error),
	#[error("{0}")]
	ParseInt(#[from] std::num::ParseIntError),
	#[error("Scheduling jobs on {0:?} is only allowed for weekly jobs.  Using specific days on a job scheduled to run every 2 or more weeks is not supported")]
	Weekday(Weekday),
	#[error("Cannot schedule {0:?} job, already scheduled for {1:?}")]
	WeekdayCollision(Weekday, Weekday),
	#[error("Invalid unit without specifying start day")]
	UnspecifiedStartDay,
}

/// Construct a new Unit error.
pub(crate) fn unit_error(intended: Unit, existing: Unit) -> Error {
	Error::Unit(intended, existing)
}

/// Construct a new invalid hour error.
pub(crate) fn invalid_hour_error(hour: i8) -> Error {
	Error::InvalidHour(hour)
}

/// Construct a new Interval error.
pub(crate) fn interval_error(interval: Unit) -> Error {
	Error::Interval(interval)
}

/// Construct a new Weekday error.
pub(crate) fn weekday_error(weekday: Weekday) -> Error {
	Error::Weekday(weekday)
}

/// Construct a new Weekday collision error.
pub(crate) fn weekday_collision_error(intended: Weekday, existing: Weekday) -> Error {
	Error::WeekdayCollision(intended, existing)
}

pub type Result<T> = std::result::Result<T, Error>;