oxide-batch 0.6.0

Rust-native framework for reliable, restartable batch processing, inspired by Spring Batch
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

//! The cancellable backoff waiting contract.

use std::time::Duration;

use crate::{BoxFuture, StopToken};

/// The result of one cancellable backoff wait.
#[derive(Clone, Copy, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[non_exhaustive]
pub enum BackoffOutcome {
    /// The complete delay elapsed.
    Elapsed,
    /// Cooperative stop cancelled the wait.
    Stopped,
}

/// An injected monotonic, cancellable delay source.
///
/// Implementations must not detach a task or timer, must observe the supplied
/// [`StopToken`] while waiting, and must not consult wall-clock time.
pub trait BackoffSleeper: Send + Sync {
    /// Waits for `delay` unless cooperative stop is observed first.
    fn sleep<'a>(&'a self, delay: Duration, stop: &'a StopToken) -> BoxFuture<'a, BackoffOutcome>;
}