Struct Scheduler

pub struct Scheduler { /* private fields */ }

The Scheduler container

Implementations

impl Scheduler

pub fn handle(&self) -> SchedulerHandle

Get the SchedulerHandle for this scheduler. Can be used to setup tasks that cancel themselves on some condition.

pub fn once<F>(f: F) -> Self

where F: FnMut() + Send + 'static,

Create a scheduler to run a one-time job in a background thread

Examples found in repository

examples/simple.rs (line 2)

fn main() {
    let _once_handle = scheduling::Scheduler::once(|| println!("ONCE")).start();

    let recurring_handle = scheduling::Scheduler::delayed_recurring(
        std::time::Duration::from_secs(1),
        std::time::Duration::from_secs(1),
        || println!("1 SEC ELAPSED"),
    )
    .start();

    std::thread::sleep(std::time::Duration::from_secs(5));

    recurring_handle.cancel();

    std::thread::sleep(std::time::Duration::from_secs(5));
}

pub fn delayed_once<F>(delay: Duration, f: F) -> Self

where F: FnMut() + Send + 'static,

Create a scheduler to run a one-time job with an initial delay

pub fn recurring<F>(rate: Duration, f: F) -> Self

where F: FnMut() + Send + 'static,

Create a scheduler to run a recurring job at a fixed rate

pub fn delayed_recurring<F>(delay: Duration, rate: Duration, f: F) -> Self

where F: FnMut() + Send + 'static,

Create a scheduler to run a recurring job at a fixed rate, with an initial delay

Examples found in repository

examples/simple.rs (lines 4-8)

fn main() {
    let _once_handle = scheduling::Scheduler::once(|| println!("ONCE")).start();

    let recurring_handle = scheduling::Scheduler::delayed_recurring(
        std::time::Duration::from_secs(1),
        std::time::Duration::from_secs(1),
        || println!("1 SEC ELAPSED"),
    )
    .start();

    std::thread::sleep(std::time::Duration::from_secs(5));

    recurring_handle.cancel();

    std::thread::sleep(std::time::Duration::from_secs(5));
}

pub fn start(self) -> SchedulerHandle

Start running the Scheduler and return its handle

Examples found in repository

examples/simple.rs (line 2)

fn main() {
    let _once_handle = scheduling::Scheduler::once(|| println!("ONCE")).start();

    let recurring_handle = scheduling::Scheduler::delayed_recurring(
        std::time::Duration::from_secs(1),
        std::time::Duration::from_secs(1),
        || println!("1 SEC ELAPSED"),
    )
    .start();

    std::thread::sleep(std::time::Duration::from_secs(5));

    recurring_handle.cancel();

    std::thread::sleep(std::time::Duration::from_secs(5));
}

Trait Implementations

impl Default for Scheduler

fn default() -> Scheduler

Returns the “default value” for a type.