dope-runtime 0.27.0

Thread-per-core execution and process lifecycle for dope
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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116

use std::{ops, time};

use o3::base::time::Positive;

use crate::{
    executor::{
        self, drain,
        drive::{self, clock},
        root, session,
    },
    shutdown,
};

/// Live application view scoped to one installed session.
#[repr(transparent)]
pub struct App<'app, 'life: 'app, 'd: 'life, D: executor::raw::Layout<'d>, Q = ()> {
    pub(crate) access: session::access::Access<'app, 'life, 'd, D, Q>,
}

impl<'app, 'life: 'app, 'd: 'life, D, Q> App<'app, 'life, 'd, D, Q>
where
    D: executor::raw::App<'d>,
    Q: executor::Startup,
{
    pub fn drive<R>(&mut self, root: R) -> Result<R::Output, drive::Error>
    where
        R: root::Root<'d>,
    {
        self.access
            .reborrow()
            .drive(clock::wall(), root, drive::tick)
    }

    pub fn run(self) -> Result<shutdown::Requested<Q>, drive::Error> {
        self.access.run()?;
        Ok(shutdown::Requested::new())
    }

    /// Returns a completed root or the shutdown request after dropping the pending root.
    /// A root completed in the shutdown turn keeps its output.
    pub fn drive_until<R>(
        self,
        root: R,
    ) -> Result<ops::ControlFlow<R::Output, shutdown::Requested<Q>>, drive::Error>
    where
        R: root::Root<'d>,
    {
        Ok(self
            .access
            .drive_until(root)?
            .map_continue(|()| shutdown::Requested::new()))
    }

    /// Drives one root with a wall-clock deadline, checked between executor turns.
    /// Each root poll must return to the executor for the deadline to be observed.
    pub fn drive_for<R>(
        &mut self,
        timeout: time::Duration,
        root: R,
    ) -> Result<R::Output, drive::Error>
    where
        R: root::Root<'d>,
    {
        let source = clock::Bound::until(clock::wall(), timeout)?;
        self.access.reborrow().drive(source, root, drive::timeout)
    }

    /// Serves until shutdown or the wall-clock deadline, checked between turns.
    /// Each application transition must return to the executor.
    pub fn run_for(self, timeout: time::Duration) -> Result<shutdown::Requested<Q>, drive::Error> {
        self.access.run_for(timeout)?;
        Ok(shutdown::Requested::new())
    }

    pub fn run_drain(self, timeout: Positive) -> Result<drain::Report<Q>, drive::Error>
    where
        D: executor::raw::Drain<'d>,
    {
        let outcome = self.access.run_drain(timeout)?;
        Ok(drain::Report::new(shutdown::Requested::new(), outcome))
    }

    /// Returns a completed root, or drains after shutdown once the pending root is dropped.
    /// A root completed in the shutdown turn keeps its output; the drain timeout starts at shutdown.
    pub fn drive_drain<R>(
        self,
        timeout: Positive,
        root: R,
    ) -> Result<ops::ControlFlow<R::Output, drain::Report<Q>>, drive::Error>
    where
        D: executor::raw::Drain<'d>,
        R: root::Root<'d>,
    {
        Ok(self
            .access
            .drive_drain(timeout, root)?
            .map_continue(|outcome| drain::Report::new(shutdown::Requested::new(), outcome)))
    }
}

impl<'app, 'life: 'app, 'd: 'life, D, Q> ops::Deref for App<'app, 'life, 'd, D, Q>
where
    D: executor::raw::Layout<'d>,
{
    type Target = session::access::Access<'app, 'life, 'd, D, Q>;

    fn deref(&self) -> &Self::Target {
        &self.access
    }
}

impl<'d, D: executor::raw::Layout<'d>, Q> ops::DerefMut for App<'_, '_, 'd, D, Q> {
    fn deref_mut(&mut self) -> &mut Self::Target {
        &mut self.access
    }
}