rust-tokio-supervisor 0.1.3

A Rust tokio supervisor with declarative task supervision, restart policy, shutdown coordination, and observability.
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

//! Runtime-owned shutdown pipeline helpers.
//!
//! This module stores cached shutdown reports. Active child handles live in
//! child runtime state records owned by the control loop.

use crate::shutdown::report::ShutdownPipelineReport;

/// Shutdown pipeline state stored by the runtime control loop.
#[derive(Debug, Default)]
pub(crate) struct ShutdownPipeline {
    /// Cached report after the first completed shutdown.
    cached_report: Option<ShutdownPipelineReport>,
}

impl ShutdownPipeline {
    /// Creates an empty shutdown pipeline cache.
    ///
    /// # Arguments
    ///
    /// This function has no arguments.
    ///
    /// # Returns
    ///
    /// Returns a [`ShutdownPipeline`].
    pub(crate) fn new() -> Self {
        Self::default()
    }

    /// Returns the cached shutdown report.
    ///
    /// # Arguments
    ///
    /// This function has no arguments.
    ///
    /// # Returns
    ///
    /// Returns the cached shutdown report when shutdown already completed.
    pub(crate) fn cached_report(&self) -> Option<&ShutdownPipelineReport> {
        self.cached_report.as_ref()
    }

    /// Stores the completed shutdown report.
    ///
    /// # Arguments
    ///
    /// - `report`: Completed report to cache.
    ///
    /// # Returns
    ///
    /// This function does not return a value.
    pub(crate) fn cache_report(&mut self, report: ShutdownPipelineReport) {
        self.cached_report = Some(report);
    }
}