faktory 0.13.1

API bindings for the language-agnostic Faktory work server
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

use std::fmt::{Debug, Display};

#[cfg(doc)]
use super::{Worker, WorkerBuilder};

#[derive(Debug, Default, Clone, PartialEq, Eq, Serialize, Deserialize)]
/// A reason why [`Worker::run`] has discontinued.
#[non_exhaustive]
pub enum StopReason {
    /// Graceful shutdown completed.
    ///
    /// A future provided via [`WorkerBuilder::with_graceful_shutdown`] has resolved
    /// signalling the worker to stop.
    #[default]
    GracefulShutdown,

    /// The Faktory server asked us to shut down.
    ///
    /// Under the hood, the worker is in constant communication with the Faktory server.
    /// It fetches jobs and reports on processing results, but also listens for the server's
    /// instructions. One of those instructions can be to disengage (e.g., to indicate that the
    /// server is shutting down.
    ServerInstruction,
}

impl Display for StopReason {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        Debug::fmt(&self, f)
    }
}

#[derive(Debug, Default, Clone, PartialEq, Eq, Serialize, Deserialize)]
/// Holds some details aroung a worker's run stoppage, such as the reason why this worker discontinued
/// and the number of workers that might still be processing jobs at that instant.
#[non_exhaustive]
pub struct StopDetails {
    /// The [reason](StopReason) why the worker's run has discontinued.
    pub reason: StopReason,

    /// The number of workers that might still be processing jobs.
    pub workers_still_running: usize,
}

impl StopDetails {
    pub(crate) fn new(reason: StopReason, nrunning: usize) -> Self {
        StopDetails {
            reason,
            workers_still_running: nrunning,
        }
    }
}