graphile_worker_lifecycle_hooks 0.3.3

Lifecycle hooks for graphile_worker, a high performance Rust/PostgreSQL job queue
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

use futures::future::BoxFuture;

use crate::result::{HookResult, JobRecoveryResult, JobScheduleResult};
use crate::TypeErasedHooks;

pub trait HookOutput: Default + Send + 'static {
    type ChainValue: Clone + Send;

    fn is_terminal(&self) -> bool {
        false
    }

    fn chain_value(&self) -> Option<Self::ChainValue> {
        None
    }

    fn default_with_value(_value: Self::ChainValue) -> Self {
        Self::default()
    }
}

impl HookOutput for () {
    type ChainValue = ();
}

impl HookOutput for HookResult {
    type ChainValue = ();

    fn is_terminal(&self) -> bool {
        !matches!(self, HookResult::Continue)
    }
}

impl HookOutput for JobRecoveryResult {
    type ChainValue = ();

    fn is_terminal(&self) -> bool {
        !matches!(self, JobRecoveryResult::Default)
    }
}

impl HookOutput for JobScheduleResult {
    type ChainValue = serde_json::Value;

    fn is_terminal(&self) -> bool {
        !matches!(self, JobScheduleResult::Continue(_))
    }

    fn chain_value(&self) -> Option<Self::ChainValue> {
        match self {
            JobScheduleResult::Continue(v) => Some(v.clone()),
            _ => None,
        }
    }

    fn default_with_value(value: Self::ChainValue) -> Self {
        JobScheduleResult::Continue(value)
    }
}

pub trait Event: Send + Sync + 'static {
    type Context: Clone + Send + 'static;
    type Output: HookOutput;

    #[doc(hidden)]
    fn register_boxed(
        hooks: &mut TypeErasedHooks,
        handler: Box<dyn Fn(Self::Context) -> BoxFuture<'static, Self::Output> + Send + Sync>,
    );
}

pub trait Interceptable: Clone + Send + 'static {
    type Output: HookOutput;

    #[doc(hidden)]
    fn intercept_with(self, hooks: &TypeErasedHooks) -> BoxFuture<'_, Self::Output>;
}