canic-core 0.27.0

Canic — a canister orchestration and management toolkit for the Internet Computer
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
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76

use crate::ops::runtime::timer::TimerOps;
use std::{cell::RefCell, future::Future, thread::LocalKey, time::Duration};

// re-exports
pub use crate::ops::runtime::timer::TimerId;

///
/// TimerWorkflow
///

pub struct TimerWorkflow;

impl TimerWorkflow {
    pub fn set(
        delay: Duration,
        label: impl Into<String>,
        task: impl Future<Output = ()> + 'static,
    ) -> TimerId {
        TimerOps::set(delay, label, task)
    }

    pub fn set_interval<F, Fut>(interval: Duration, label: impl Into<String>, task: F) -> TimerId
    where
        F: FnMut() -> Fut + 'static,
        Fut: Future<Output = ()> + 'static,
    {
        TimerOps::set_interval(interval, label, task)
    }

    pub fn clear(id: TimerId) {
        TimerOps::clear(id);
    }

    pub fn set_guarded(
        slot: &'static LocalKey<RefCell<Option<TimerId>>>,
        delay: Duration,
        label: impl Into<String>,
        task: impl Future<Output = ()> + 'static,
    ) -> bool {
        TimerOps::set_guarded(slot, delay, label, task)
    }

    pub fn set_guarded_interval<FInit, InitFut, FTick, TickFut>(
        slot: &'static LocalKey<RefCell<Option<TimerId>>>,
        init_delay: Duration,
        init_label: impl Into<String>,
        init_task: FInit,
        interval: Duration,
        interval_label: impl Into<String>,
        tick_task: FTick,
    ) -> bool
    where
        FInit: FnOnce() -> InitFut + 'static,
        InitFut: Future<Output = ()> + 'static,
        FTick: FnMut() -> TickFut + 'static,
        TickFut: Future<Output = ()> + 'static,
    {
        TimerOps::set_guarded_interval(
            slot,
            init_delay,
            init_label,
            init_task,
            interval,
            interval_label,
            tick_task,
        )
    }

    #[must_use]
    ///
    /// NOTE: guarded one-shot timers do not auto-clear their slot on completion.
    /// Callers must clear the slot explicitly when the timer fires.
    pub fn clear_guarded(slot: &'static LocalKey<RefCell<Option<TimerId>>>) -> bool {
        TimerOps::clear_guarded(slot)
    }
}