Struct BackoffSchedule 

pub struct BackoffSchedule<B> { /* private fields */ }

Available on crate feature backoff only.

Backs off using a BackoffSchedule from the backoff crate.

Implemented for tasks returning a Result. If the result is Ok, the backoff will be reset. If the result is Err, or the job panics, the backoff increments.

Implementations

impl<B: Backoff> BackoffSchedule<B>

pub fn from_backoff(backoff: B) -> Self

Creates a BackoffSchedule using the given backoff policy.

use backoff::{ExponentialBackoff, ExponentialBackoffBuilder};
use periodically::{Schedule, BackoffSchedule};
use std::time::Duration;

let backoff: ExponentialBackoff = ExponentialBackoffBuilder::new().build();
let backoff_schedule = BackoffSchedule::from_backoff(backoff);
assert_eq!(backoff_schedule.initial(), Some(Duration::from_secs(0)));
assert!(backoff_schedule.next(Err(())).unwrap() < Duration::from_secs(1));

Trait Implementations

impl<T, E, B: Backoff + Send> Schedule<Result<T, E>> for BackoffSchedule<B>

fn next(&self, task_output: Result<T, E>) -> Option<Duration>

Returns the time until this task should be scheduled again. None indicates that this task should never run again. task_output is the last return value of the task, which can be ignored if desired.

fn next_on_task_panic(&self) -> Option<Duration>

Returns the time until this task should be scheduled again. Only called when the previous task execution fails to return a value. By default, implemented as Schedule::initial.

fn initial(&self) -> Option<Duration>

How long to wait for the initial execution. Exists since the task’s output is not available initially. Can be used to control initial task execution delays.