Struct ScheduledTask 

pub struct ScheduledTask<'a> { /* private fields */ }

A task just added to the Schedule, to narrow when it runs or add hooks. It derefs to the schedule, so adding tasks can go on in a chain.

Implementations

impl ScheduledTask<'_>

pub fn weekdays(self) -> Self

Only Monday to Friday.

pub fn weekends(self) -> Self

Only Saturday and Sunday.

pub fn days(self, days: &[Weekday]) -> Self

Only on these days.

pub fn between(self, from: &str, to: &str) -> Self

Only between two times of day (HH:MM, both included); "22:00" to "06:00" spans midnight.

pub fn timezone(self, zone: &str) -> Self

Runs in this time zone instead of APP_TIMEZONE (Asia/Jakarta, +07:00, UTC).

pub fn on_failure<F, Fut>(self, hook: F) -> Self

where F: Fn(Error, AppState) -> Fut + Send + Sync + 'static, Fut: Future<Output = ()> + Send + 'static,

Runs after a run fails or panics, with the error (e.g. to alert someone). The failure is logged either way.

pub fn ping_before(self, url: impl Into<String>) -> Self

GETs url before each run, e.g. a health check’s “start” URL (Healthchecks.io, Cronitor, Better Stack). A failing ping is logged, never stops the task.

pub fn then_ping(self, url: impl Into<String>) -> Self

GETs url after each run, however it went.

pub fn ping_on_success(self, url: impl Into<String>) -> Self

GETs url after a successful run.

pub fn ping_on_failure(self, url: impl Into<String>) -> Self

GETs url after a failed run.

pub fn on_success<F, Fut>(self, hook: F) -> Self

where F: Fn(AppState) -> Fut + Send + Sync + 'static, Fut: Future<Output = ()> + Send + 'static,

Runs after a run succeeds.

Methods from Deref<Target = Schedule>

pub fn every<F, Fut>( &mut self, interval: Duration, name: &str, task: F, ) -> ScheduledTask<'_>

where F: Fn(AppState) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result> + Send + 'static,

Every interval, aligned to the clock (every 5 minutes runs at :00, :05, …).

pub fn every_minute<F, Fut>(&mut self, name: &str, task: F) -> ScheduledTask<'_>

where F: Fn(AppState) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result> + Send + 'static,

Every minute, on the minute.

pub fn every_minutes<F, Fut>( &mut self, minutes: u64, name: &str, task: F, ) -> ScheduledTask<'_>

where F: Fn(AppState) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result> + Send + 'static,

Every minutes minutes, aligned to the clock (every 15 runs at :00, :15, …).

pub fn hourly<F, Fut>(&mut self, name: &str, task: F) -> ScheduledTask<'_>

where F: Fn(AppState) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result> + Send + 'static,

Every hour, on the hour.

pub fn cron<F, Fut>( &mut self, expression: &str, name: &str, task: F, ) -> ScheduledTask<'_>

where F: Fn(AppState) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result> + Send + 'static,

When the wall clock matches a cron expression: minute, hour, day of month, month, day of week (0/7 or SUN), with *, a-b, lists and /step; also @hourly, @daily, @weekly, @monthly, @yearly. "30 9 * * 1-5" is 09:30 on weekdays.

pub fn daily_at<F, Fut>( &mut self, time: &str, name: &str, task: F, ) -> ScheduledTask<'_>

where F: Fn(AppState) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result> + Send + 'static,

Every day at HH:MM.

pub fn weekly_on<F, Fut>( &mut self, day: Weekday, time: &str, name: &str, task: F, ) -> ScheduledTask<'_>

where F: Fn(AppState) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result> + Send + 'static,

Every week on day at HH:MM.

pub fn monthly_on<F, Fut>( &mut self, day: u32, time: &str, name: &str, task: F, ) -> ScheduledTask<'_>

where F: Fn(AppState) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result> + Send + 'static,

Every month on day (1–31; months without that day are skipped, so use 28 or lower for every month) at HH:MM.

pub fn upcoming(&self, zone: Zone) -> Vec<UpcomingRun>

Each task with its next run (in zone unless the task has its own), as schedule:list shows them.

pub async fn run_now(&self, state: AppState, name: &str) -> Result

Runs the task name now, whatever its schedule (schedule:run).

Trait Implementations

impl Deref for ScheduledTask<'_>

type Target = Schedule

The resulting type after dereferencing.

fn deref(&self) -> &Schedule

Dereferences the value.

impl DerefMut for ScheduledTask<'_>

fn deref_mut(&mut self) -> &mut Schedule

Mutably dereferences the value.