graft 0.2.1

The Graft storage engine.
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

use std::{fmt::Debug, sync::Arc};
use tracing::Instrument;

use crate::{GraftErr, local::fjall_storage::FjallStorage, remote::Remote};

pub mod autosync;

pub type Result<T> = culprit::Result<T, GraftErr>;

/// A long running stateful async background task.
pub trait Task: Debug {
    const NAME: &'static str;

    /// Run the task.
    async fn run(&mut self, storage: &FjallStorage, remote: &Remote) -> Result<()>;

    /// Decide whether or not to restart the task on error.
    #[allow(unused_variables)]
    fn should_restart(&self, err: &GraftErr) -> bool {
        true
    }
}

/// Supervise a long running task.
/// If the task completes, this function will also complete.
/// If the task fails, `T::should_restart` is consulted.
pub async fn supervise<T: Task>(
    storage: Arc<FjallStorage>,
    remote: Arc<Remote>,
    mut task: T,
) -> Result<()> {
    for restarts in 0usize.. {
        let span = tracing::debug_span!("task", t = T::NAME, r = restarts);
        match task.run(&storage, &remote).instrument(span).await {
            Ok(()) => {
                tracing::debug!("task {:?} completed without error; shutting down", task);
                break;
            }
            Err(err) => {
                tracing::error!("task {:?} failed: {:?}", task, err);
                if !task.should_restart(err.ctx()) {
                    return Err(err);
                }
            }
        }
        tracing::debug!("restarting task {:?}", task);
    }
    Ok(())
}