apalis-core 1.0.0

Core for apalis: simple, extensible multithreaded background processing for Rust
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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107

//! Traits for converting types into responses for task functions.

use crate::error::BoxDynError;

/// Trait for generating responses.
///
/// Types that implement `IntoResponse` can be returned from a task fn.
///
/// # Implementing `IntoResponse`
///
/// You generally shouldn't have to implement `IntoResponse` manually, as apalis
/// provides implementations for many common types.
///
/// However it might be necessary if you have a custom error type that you want
/// to return from a task fn:
///
/// ```rust
/// # use apalis_core::task::into_response::IntoResponse;
/// # use apalis_core::error::BoxDynError;
/// enum CustomResult {
///     Success(String),
///     Recoverable(BoxDynError),
///     Failure(BoxDynError),
/// }
/// impl IntoResponse for CustomResult {
///     type Output = String;
///     fn into_response(self) -> Result<Self::Output, BoxDynError> {
///         match self {
///             CustomResult::Success(val) => Ok(val),
///             CustomResult::Recoverable(err) => Err(err),
///             CustomResult::Failure(err) => Err(err),
///         }
///    }    
/// }
///
/// async fn my_task() -> CustomResult {
///     CustomResult::Success("All good".to_string())
/// }
/// ```
pub trait IntoResponse {
    /// The final result of the job
    type Output;

    /// converts self into a Result
    fn into_response(self) -> Result<Self::Output, BoxDynError>;
}

impl IntoResponse for bool {
    type Output = Self;
    fn into_response(self) -> Result<Self, BoxDynError> {
        match self {
            true => Ok(true),
            false => Err("Task returned false".into()),
        }
    }
}

impl<T> IntoResponse for Option<T> {
    type Output = Self;
    fn into_response(self) -> Result<Self, BoxDynError> {
        Ok(self)
    }
}

impl<T, E: Into<BoxDynError> + Send + 'static> IntoResponse for std::result::Result<T, E> {
    type Output = T;
    fn into_response(self) -> Result<T, BoxDynError> {
        match self {
            Ok(value) => Ok(value),
            Err(err) => Err(err.into()),
        }
    }
}

impl<T: IntoResponse> IntoResponse for Vec<T> {
    type Output = Self;
    fn into_response(self) -> Result<Self, BoxDynError> {
        Ok(self)
    }
}

macro_rules! SIMPLE_JOB_RESULT {
    ($type:ty) => {
        impl IntoResponse for $type {
            type Output = $type;
            fn into_response(self) -> std::result::Result<$type, BoxDynError> {
                Ok(self)
            }
        }
    };
}

SIMPLE_JOB_RESULT!(());
SIMPLE_JOB_RESULT!(u8);
SIMPLE_JOB_RESULT!(u16);
SIMPLE_JOB_RESULT!(u32);
SIMPLE_JOB_RESULT!(u64);
SIMPLE_JOB_RESULT!(usize);
SIMPLE_JOB_RESULT!(i8);
SIMPLE_JOB_RESULT!(i16);
SIMPLE_JOB_RESULT!(i32);
SIMPLE_JOB_RESULT!(i64);
SIMPLE_JOB_RESULT!(isize);
SIMPLE_JOB_RESULT!(f32);
SIMPLE_JOB_RESULT!(f64);
SIMPLE_JOB_RESULT!(String);
SIMPLE_JOB_RESULT!(&'static str);