spawn_interval

Call a subroutine at a constant time interval.

Examples

Basic

```rust use std::{thread, time::Duration}; use spawn_interval;

fn on_tick() { println!("tick!"); }

fn main() { let cancel = spawninterval::spawninterval(&ontick, Duration::frommillis(500));

// Waiting before cancelling this instance of spawn_interval.
thread::sleep(Duration::from_secs(3));

cancel();

println!("This instance of spawn_interval has been succesfully stopped");

// Sleeping for a long time for the sake of this example.
thread::sleep(Duration::from_millis(u64::MAX));

}

```

Inner function

```rust use std::{thread, time::Duration}; use spawn_interval;

fn main() { let on_tick = || { println!("tick!"); };

// Leaking this inner function to make its lifetime as 'static.
// https://doc.rust-lang.org/std/boxed/struct.Box.html#method.leak
let static_on_tick = Box::leak(Box::new(on_tick));

let cancel = spawn_interval::spawn_interval(static_on_tick, Duration::from_millis(500));

// Waiting before cancelling this instance of spawn_interval.
thread::sleep(Duration::from_secs(3));

cancel();

println!("This instance of spawn_interval has been succesfully stopped");

// Sleeping for a long time for the sake of this example.
thread::sleep(Duration::from_millis(u64::MAX));

}

```

Capturing inner function

```rust use std::{ sync::{Arc, Mutex}, thread, time::Duration, };

fn main() { // The data shared with the given callback has to be thread-safe. // https://doc.rust-lang.org/nomicon/send-and-sync.html let counter = Arc::new(Mutex::new(10)); let canceloption: Arc>>> = Arc::new(Mutex::new(None)); let canceloptionclone = canceloption.clone();

let on_tick = move || {
    let mut c = counter.lock().unwrap();
    if *c == 0 {
        cancel_option_clone.lock().unwrap().as_ref().unwrap()();
        println!("We have a liftoff!");
        println!("This instance of spawn_interval has been succesfully stopped");
    } else {
        println!("{}", c);
        *c -= 1;
    }
};

// Leaking this inner function to make its lifetime as 'static.
// https://doc.rust-lang.org/std/boxed/struct.Box.html#method.leak
let static_on_tick = Box::leak(Box::new(on_tick));

let cancel = spawn_interval::spawn_interval(static_on_tick, Duration::from_secs(1));

*cancel_option.lock().unwrap() = Some(cancel);

// Sleeping for a long time for the sake of this example.
thread::sleep(Duration::from_millis(u64::MAX));

}

```