rust-tokio-supervisor 0.1.2

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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82

//! Task attempt exit classification.
//!
//! This module converts task results and runtime failures into a typed exit
//! model that policy code can consume without string parsing.

use crate::error::types::{TaskFailure, TaskFailureKind};
use crate::task::factory::TaskResult;

/// Exit classification for one task attempt.
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum TaskExit {
    /// The task returned success.
    Succeeded,
    /// The task returned cancellation.
    Cancelled,
    /// The task returned a typed failure.
    Failed(TaskFailure),
    /// The task panicked before returning a result.
    Panicked(String),
    /// The task timed out.
    TimedOut,
}

impl TaskExit {
    /// Converts a task result into an exit classification.
    ///
    /// # Arguments
    ///
    /// - `result`: Task result returned by the task future.
    ///
    /// # Returns
    ///
    /// Returns the corresponding [`TaskExit`].
    ///
    /// # Examples
    ///
    /// ```
    /// let exit = rust_supervisor::child_runner::attempt::TaskExit::from_task_result(
    ///     rust_supervisor::task::factory::TaskResult::Succeeded,
    /// );
    /// assert!(exit.is_success());
    /// ```
    pub fn from_task_result(result: TaskResult) -> Self {
        match result {
            TaskResult::Succeeded => Self::Succeeded,
            TaskResult::Cancelled => Self::Cancelled,
            TaskResult::Failed(failure) => Self::Failed(failure),
        }
    }

    /// Returns whether this exit represents a successful task.
    ///
    /// # Arguments
    ///
    /// This function has no arguments.
    ///
    /// # Returns
    ///
    /// Returns `true` only for [`TaskExit::Succeeded`].
    pub fn is_success(&self) -> bool {
        matches!(self, Self::Succeeded)
    }

    /// Returns the failure kind for policy evaluation.
    ///
    /// # Arguments
    ///
    /// This function has no arguments.
    ///
    /// # Returns
    ///
    /// Returns `None` for successful exits.
    pub fn failure_kind(&self) -> Option<TaskFailureKind> {
        match self {
            Self::Succeeded => None,
            Self::Cancelled => Some(TaskFailureKind::Cancelled),
            Self::Failed(failure) => Some(failure.kind.clone()),
            Self::Panicked(_message) => Some(TaskFailureKind::Panic),
            Self::TimedOut => Some(TaskFailureKind::Timeout),
        }
    }
}