Skip to main content

Scheduler

Struct Scheduler 

Source
pub struct Scheduler { /* private fields */ }
Expand description

A @Scheduled-style background task runner.

Register tasks with .every(), .after(), or .cron(), then call .start() to spawn one dedicated background thread per task.

Implementations§

Source§

impl Scheduler

Source

pub fn new() -> Self

Source

pub fn every( self, interval: Duration, task: impl Fn() + Send + Sync + 'static, ) -> Self

Run task every interval, measured from the start of the previous run. If the task takes longer than interval, the next run starts immediately.

Source

pub fn after( self, delay: Duration, task: impl Fn() + Send + Sync + 'static, ) -> Self

Run task with delay between the end of one run and the start of the next.

Source

pub fn cron( self, expr: &str, task: impl Fn() + Send + Sync + 'static, ) -> Result<Self, String>

Run task according to a 6-field cron expression.

Format: "second minute hour day-of-month month day-of-week" (UTC).

Each field supports *, an exact value, */step, an N-M range, and comma-separated combinations, e.g. "0,30 * * * * *" fires at seconds 0 and 30.

Day-of-week: 0 = Sunday, 6 = Saturday.

Source

pub fn initial_delay(self, delay: Duration) -> Self

Add an initial delay before the first run of the most recently registered task.

Source

pub fn start(self)

Spawn one background thread per registered task and return immediately. Threads run for the lifetime of the process.

Trait Implementations§

Source§

impl Default for Scheduler

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more