rust-tokio-supervisor 0.1.4

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
55
56
57
58
59
60
61
62
63
64

//! Sidecar role trait contract.
//!
//! Implement this trait when an auxiliary sidecar should be adapted into the
//! supervisor task factory runtime while keeping the primary child identifier
//! visible.

use crate::role::context::sidecar::SidecarContext;
use crate::role::result::sidecar::SidecarResult;
use std::future::Future;

/// Explicit lifecycle contract for a sidecar role.
pub trait SidecarRole: Send + 'static {
    /// Runs initialization before the sidecar body starts.
    ///
    /// # Arguments
    ///
    /// - `ctx`: Sidecar-specific context for readiness, heartbeat, and primary child access.
    ///
    /// # Returns
    ///
    /// Returns a future that resolves when initialization succeeds or fails.
    fn init<'a>(
        &'a mut self,
        ctx: &'a SidecarContext,
    ) -> impl Future<Output = SidecarResult<()>> + Send + 'a {
        async move {
            let _ = ctx;
            Ok(())
        }
    }

    /// Runs the sidecar body.
    ///
    /// # Arguments
    ///
    /// - `ctx`: Sidecar-specific context for shutdown and primary child observation.
    ///
    /// # Returns
    ///
    /// Returns a future that resolves when the sidecar exits.
    fn run<'a>(
        &'a mut self,
        ctx: &'a SidecarContext,
    ) -> impl Future<Output = SidecarResult<()>> + Send + 'a;

    /// Runs the sidecar shutdown hook.
    ///
    /// # Arguments
    ///
    /// - `ctx`: Sidecar-specific context for final shutdown work.
    ///
    /// # Returns
    ///
    /// Returns a future that resolves when shutdown succeeds or fails.
    fn shutdown<'a>(
        &'a mut self,
        ctx: &'a SidecarContext,
    ) -> impl Future<Output = SidecarResult<()>> + Send + 'a {
        async move {
            let _ = ctx;
            Ok(())
        }
    }
}