aj_core 0.8.0

Background Job Library 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

use async_trait::async_trait;
use chrono::{DateTime, Utc};
use std::fmt::Debug;

use super::{job_context::JobContext, retry::Retry};

#[async_trait]
pub trait Executable {
    type Output: Debug + Send;

    async fn pre_execute(&mut self, _context: &'_ JobContext) {}

    async fn execute(&mut self, _context: &'_ JobContext) -> Self::Output;

    async fn post_execute(
        &mut self,
        output: Self::Output,
        _context: &'_ JobContext,
    ) -> Self::Output {
        output
    }

    // Identify job is failed or not. Default is false
    // You can change id_failed_output logic to handle retry logic
    async fn is_failed_output(&self, _job_output: &Self::Output) -> bool {
        false
    }

    // Job will re-run if should_retry return a specific time in the future
    async fn retry_at(
        &self,
        retry_context: &mut Retry,
        job_output: Self::Output,
    ) -> Option<DateTime<Utc>> {
        let should_retry = self.is_failed_output(&job_output).await && retry_context.should_retry();

        if should_retry {
            Some(retry_context.retry_at(None))
        } else {
            None
        }
    }
}