dope-core 0.15.0

The manifold runtime
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
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141

use std::io;

use o3::cell::{brand, region};

use crate::{
    backend::{self, fixed},
    driver::{
        self, flight,
        ops::{reactors, retirements},
        schedule,
        schedule::timer,
    },
};

mod domain;
mod finalize;
mod install;
mod sealed;

pub use domain::Domain;
pub(crate) use domain::Source;
pub use finalize::Finalize;
pub use install::Install;
pub(in crate::driver) use sealed::Lease;
pub mod quiesce;
#[doc(hidden)]
pub mod raw;
pub mod routing;

pub struct Scope<'d> {
    driver: driver::Reference<'d>,
    backend: &'d mut backend::Backend,
    flights: &'d mut flight::Arena,
    work: schedule::Work,
    region: region::Token<'d>,
    token: brand::Token<'d>,
    timer: &'d timer::Timer<'d>,
    _owner: quiesce::Lease,
}

impl<'d> Scope<'d> {
    pub(in crate::driver) fn new(
        driver: driver::Reference<'d>,
        backend: &'d mut backend::Backend,
        flights: &'d mut flight::Arena,
        region: region::Token<'d>,
        token: brand::Token<'d>,
        timer: &'d timer::Timer<'d>,
        owner: quiesce::Lease,
    ) -> Self {
        Self {
            driver,
            backend,
            flights,
            work: schedule::Work::new(),
            region,
            token,
            timer,
            _owner: owner,
        }
    }

    pub fn context(&mut self) -> driver::Context<'_, 'd> {
        driver::Context::new(
            self.driver,
            &mut *self.backend,
            &mut *self.flights,
            &mut self.region,
            self.timer,
        )
    }

    pub fn token(&mut self) -> &mut brand::Token<'d> {
        &mut self.token
    }

    /// Runs with the sole scheduler coordinator for this driver scope.
    ///
    /// ```compile_fail
    /// use dope_core::driver::{lifecycle::Scope, schedule::Controller};
    ///
    /// fn escape<'d>(scope: &mut Scope<'d>) -> Controller<'static, 'd> {
    ///     scope.with_turn(|_, _, turn| turn)
    /// }
    /// ```
    pub fn with_turn<R>(
        &mut self,
        run: impl for<'scope> FnOnce(
            &'scope mut brand::Token<'d>,
            driver::Context<'scope, 'd>,
            schedule::Controller<'scope, 'd>,
        ) -> R,
    ) -> R {
        let context = driver::Context::new(
            self.driver,
            &mut *self.backend,
            &mut *self.flights,
            &mut self.region,
            self.timer,
        );
        run(
            &mut self.token,
            context,
            schedule::Controller::new(self.driver, &mut self.work),
        )
    }

    pub fn driver_ref(&self) -> driver::Reference<'d> {
        self.driver
    }

    #[doc(hidden)]
    pub fn final_quiescence(
        &mut self,
    ) -> io::Result<(&mut brand::Token<'d>, quiesce::Final<'_, 'd>)> {
        let context = driver::Context::new(
            self.driver,
            &mut *self.backend,
            &mut *self.flights,
            &mut self.region,
            self.timer,
        );
        let finalization = quiesce::Final::new(context)?;
        Ok((&mut self.token, finalization))
    }

    #[doc(hidden)]
    pub fn reap_finalized(&mut self) -> io::Result<()> {
        let mut context = driver::Context::new(
            self.driver,
            &mut *self.backend,
            &mut *self.flights,
            &mut self.region,
            self.timer,
        );
        reactors::Returned::reclaim_all(&mut context);
        retirements::Reclaimer::<true>::new(&mut context).all();
        let (backend, drain) = context.backend_drain();
        fixed::Finalize::settle(backend, drain)
    }
}