crb_runtime/
runtime.rs

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
//! A runtime for composable blocks.

use crate::context::Context;
use crate::interruptor::Interruptor;
use async_trait::async_trait;

/*
/// A runtime that can be executed as
/// a standalone activity.
#[async_trait]
pub trait StandaloneRuntime<T> {
    /// Returns a runtime that has to be used in an async context.
    fn new(input: T, label: Label) -> Self;

    /// Run routine in place.
    async fn run(self);
}
*/

/// A runtime that can be executed by a supervisor.
#[async_trait]
pub trait SupervisedRuntime
where
    Self: Send + 'static,
{
    /// Type of the composable block's contenxt.
    type Context: Context;

    /// Used by a lifetime tracker of the supervisor to stop it.
    /// It's the separate type that wraps address made by a runtime.
    fn get_interruptor(&mut self) -> Box<dyn Interruptor>;

    /// Interruptor can interrupt this routine.
    ///
    /// The `notifier` is passed by a reference to fully avoid cloning
    /// or passing it somewhere to let it outlive this trackable object.
    async fn routine(self);

    /// Gets a reference to a context.
    fn context(&self) -> &Self::Context;
}