Struct Schedule 

pub struct Schedule { /* private fields */ }

The app’s scheduled tasks.

Implementations

impl 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.

impl Schedule

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 Clone for Schedule

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for Schedule

fn default() -> Self

Returns the “default value” for a type.