dope-runtime 0.32.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

use std::{marker, pin};

use dope_core::driver::{self, schedule::clock::Sample};

use crate::{
    executor::{self, drive, drive::clock, session},
    topology::lending,
};

/// Affine construction and execution access for one exact provider and session.
pub struct Permit<'issued, 'life: 'issued, 'd: 'life, O, Q> {
    core: &'issued mut session::Core<'life, 'd, Q>,
    owner: pin::Pin<&'issued mut O>,
    start: Sample,
    source: marker::PhantomData<fn(&'issued ()) -> &'issued ()>,
}

impl<'issued, 'life: 'issued, 'd: 'life, O, Q> Permit<'issued, 'life, 'd, O, Q> {
    pub(crate) fn new(
        core: &'issued mut session::Core<'life, 'd, Q>,
        owner: pin::Pin<&'issued mut O>,
        start: Sample,
    ) -> Self {
        Self {
            core,
            owner,
            start,
            source: marker::PhantomData,
        }
    }

    pub fn driver(&mut self) -> driver::Context<'_, 'd> {
        self.core.scope.context()
    }
}

impl<'issued, 'life: 'issued, 'd: 'life, O, Q> Permit<'issued, 'life, 'd, O, Q>
where
    O: lending::raw::Resume<'d>,
    Q: executor::Startup,
{
    /// Consumes construction authority and retires the dependent application.
    pub fn execute<A, E>(self, app: A) -> lending::Outcome<'issued, 'life, 'd, O, Q, E>
    where
        A: executor::raw::App<'d>,
    {
        self.run(app, (), |(), app| app.run())
    }

    /// Builds a dependent application and consumes its data in the same client scope.
    pub fn try_run<A, D, E, R>(
        mut self,
        build: impl FnOnce(driver::Context<'_, 'd>) -> Result<(A, D), E>,
        run: impl for<'run> FnOnce(
            D,
            session::App<'run, 'life, 'd, lending::raw::Bound<'issued, 'd, O, A>, Q>,
        ) -> R,
    ) -> lending::Outcome<'issued, 'life, 'd, O, Q, E, R>
    where
        A: executor::raw::App<'d>,
    {
        match build(self.driver()) {
            Ok((app, data)) => self.run(app, data, run),
            Err(error) => lending::Outcome::rejected(self.core, error, self.source),
        }
    }

    fn run<A, D, E, R>(
        self,
        app: A,
        data: D,
        run: impl for<'run> FnOnce(
            D,
            session::App<'run, 'life, 'd, lending::raw::Bound<'issued, 'd, O, A>, Q>,
        ) -> R,
    ) -> lending::Outcome<'issued, 'life, 'd, O, Q, E, R>
    where
        A: executor::raw::App<'d>,
    {
        let (parent, outcome, disarm) = self.core.execute(
            self.owner,
            app,
            self.start,
            |scope| (run(data, scope.app()), clock::wall()),
            drive::tick,
        );
        lending::Outcome::executed(self.core, parent, outcome, disarm)
    }

    /// Returns the exact uninstalled provider after construction rejects its input.
    pub fn reject<E>(self, error: E) -> lending::Outcome<'issued, 'life, 'd, O, Q, E> {
        lending::Outcome::rejected(self.core, error, self.source)
    }
}