Skip to main content

Schedule

Enum Schedule 

Source
pub enum Schedule {
    Interval(Duration),
    StaggeredInterval(StaggeredIntervalSchedule),
    GroupedInterval(GroupedIntervalSchedule),
    GroupedCron(GroupedCronSchedule),
    WindowedInterval(WindowedIntervalSchedule),
    AtTimes(Vec<DateTime<Tz>>),
    Cron(CronSchedule),
}

Variants§

§

Interval(Duration)

Trigger repeatedly after the given interval.

§

StaggeredInterval(StaggeredIntervalSchedule)

Trigger repeatedly after the given interval with a stable phase.

The first run is aligned to a deterministic phase derived from the seed. If no seed is provided, the job id is used.

§

GroupedInterval(GroupedIntervalSchedule)

Trigger repeatedly after the given interval with evenly spaced group members.

The first run is aligned to a stable slot determined by the member index. An optional group seed can rotate the entire group without changing the spacing between members.

§

GroupedCron(GroupedCronSchedule)

Trigger using a cron anchor and spread members inside each anchor window.

Each 5-field cron match becomes an anchor. The scheduler assigns each member a stable slot inside spread, then repeats that slot on every subsequent anchor.

§

WindowedInterval(WindowedIntervalSchedule)

Trigger repeatedly with frequencies selected by local time windows.

§

AtTimes(Vec<DateTime<Tz>>)

Trigger at the listed wall-clock times.

The list is sorted before execution starts. An empty list is treated as a no-op schedule and exits without running.

§

Cron(CronSchedule)

Trigger using a standard 5-field cron expression.

The scheduler timezone is used to calculate the next matching wall-clock time. The expression itself does not carry timezone information.

Implementations§

Source§

impl Schedule

Source

pub fn staggered_interval(every: Duration) -> Self

Create a staggered interval schedule that defaults to the job id as the phase seed.

Source

pub fn staggered_interval_with_seed( every: Duration, seed: impl Into<String>, ) -> Self

Create a staggered interval schedule with an explicit phase seed.

Source

pub fn grouped_interval( every: Duration, group_size: u32, member_index: u32, ) -> Self

Create a grouped interval schedule with evenly spaced members.

Source

pub fn grouped_interval_with_seed( every: Duration, group_size: u32, member_index: u32, group_seed: impl Into<String>, ) -> Self

Create a grouped interval schedule and rotate the whole group with an explicit seed.

Source

pub fn grouped_cron( cron: CronSchedule, spread: Duration, group_size: u32, member_index: u32, ) -> Self

Create a grouped cron schedule with evenly spaced members.

Source

pub fn grouped_cron_with_seed( cron: CronSchedule, spread: Duration, group_size: u32, member_index: u32, group_seed: impl Into<String>, ) -> Self

Create a grouped cron schedule and rotate the whole group with an explicit seed.

Source

pub fn windowed_interval(default_every: Option<Duration>) -> Self

Create a windowed interval schedule.

Trait Implementations§

Source§

impl Clone for Schedule

Source§

fn clone(&self) -> Schedule

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Schedule

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Eq for Schedule

Source§

impl PartialEq for Schedule

Source§

fn eq(&self, other: &Schedule) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for Schedule

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.