modo-rs 0.8.0

Rust web framework for small monolithic apps
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
83

use std::future::Future;

use crate::error::Result;

use super::context::{FromJobContext, JobContext};

/// Trait implemented by all valid job handler functions.
///
/// A job handler is any `async fn` whose arguments each implement
/// [`FromJobContext`]. Up to 12 arguments are supported via blanket
/// implementations.
///
/// You never implement this trait directly — write a plain `async fn` and pass
/// it to [`WorkerBuilder::register`](super::worker::WorkerBuilder::register).
///
/// # Supported signatures
///
/// ```rust,no_run
/// use modo::job::{Payload, Meta};
/// use serde::Deserialize;
///
/// #[derive(Deserialize)]
/// struct MyPayload { value: u32 }
///
/// // Zero arguments
/// async fn job_no_args() -> modo::Result<()> { Ok(()) }
///
/// // One argument
/// async fn job_one_arg(payload: Payload<MyPayload>) -> modo::Result<()> { Ok(()) }
///
/// // Multiple arguments (up to 12)
/// async fn job_two_args(payload: Payload<MyPayload>, meta: Meta) -> modo::Result<()> { Ok(()) }
/// ```
pub trait JobHandler<Args>: Clone + Send + 'static {
    /// Invoke the handler with extracted arguments from `ctx`.
    ///
    /// # Errors
    ///
    /// Returns an error if argument extraction from the context fails or if
    /// the handler function itself returns an error.
    fn call(self, ctx: JobContext) -> impl Future<Output = Result<()>> + Send;
}

// 0 args
impl<F, Fut> JobHandler<()> for F
where
    F: FnOnce() -> Fut + Clone + Send + 'static,
    Fut: Future<Output = Result<()>> + Send,
{
    async fn call(self, _ctx: JobContext) -> Result<()> {
        (self)().await
    }
}

macro_rules! impl_job_handler {
    ($($T:ident),+) => {
        impl<F, Fut, $($T),+> JobHandler<($($T,)+)> for F
        where
            F: FnOnce($($T),+) -> Fut + Clone + Send + 'static,
            Fut: Future<Output = Result<()>> + Send,
            $($T: FromJobContext,)+
        {
            #[allow(non_snake_case)]
            async fn call(self, ctx: JobContext) -> Result<()> {
                $(let $T = $T::from_job_context(&ctx)?;)+
                (self)($($T),+).await
            }
        }
    };
}

impl_job_handler!(T1);
impl_job_handler!(T1, T2);
impl_job_handler!(T1, T2, T3);
impl_job_handler!(T1, T2, T3, T4);
impl_job_handler!(T1, T2, T3, T4, T5);
impl_job_handler!(T1, T2, T3, T4, T5, T6);
impl_job_handler!(T1, T2, T3, T4, T5, T6, T7);
impl_job_handler!(T1, T2, T3, T4, T5, T6, T7, T8);
impl_job_handler!(T1, T2, T3, T4, T5, T6, T7, T8, T9);
impl_job_handler!(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10);
impl_job_handler!(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11);
impl_job_handler!(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12);