async-repeater 1.0.0

Tokio based library for repeating tasks with user defined durations and start times.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31

use std::fmt::Debug;
use std::hash::Hash;
use std::time::Duration;

use crate::Delay;

/// Entry for the [`Repeater`](crate::Repeater)
pub trait RepeaterEntry {
    /// The type of key
    type Key: Hash + Eq + Unpin + Send + Debug;

    /// Duration after which the entry should be repeated
    fn interval(&self) -> Duration;

    /// Duration after which the first repetition is run
    ///
    /// An example: It's 2:57pm and we want to start a repetition with an interval of 60 seconds,
    /// but also want to wait until it's exactly 3pm.
    /// We'd either set the delay to be relative 180 seconds or specify the absolute unix time stamp.
    ///
    /// If not implemented, it returns Delay::None starting the repetition instantly
    fn delay(&self) -> Delay {
        Delay::None
    }

    /// To identify the entry.
    ///
    /// We don't want to store the whole entry in the underlying queue,
    /// but only a key
    fn key(&self) -> Self::Key;
}