Trait garcon::Waiter

pub trait Waiter: WaiterClone + Send + Sync {
    fn wait(&mut self) -> Result<(), WaiterError>;

    fn restart(&mut self) -> Result<(), WaiterError> { ... }
    fn start(&mut self) { ... }
}

A waiter trait, that can be used for executing a delay. Waiters need to be multi-threaded and cloneable. A waiter should not be reused twice.

Required methods

fn wait(&mut self) -> Result<(), WaiterError>

Called at each cycle of the waiting cycle. Call after starting the waiter otherwise returns an error.

Provided methods

fn restart(&mut self) -> Result<(), WaiterError>

Restart the wait timer. Call after starting the waiter otherwise returns an error.

fn start(&mut self)

Called when we start the waiting cycle.

Implementations on Foreign Types

impl Waiter for Box<dyn Waiter>

A Box of Waiter is also a Waiter

fn start(&mut self)

Called when we start the waiting cycle.

fn wait(&mut self) -> Result<(), WaiterError>

Called at each cycle of the waiting cycle. Call after starting the waiter otherwise returns an error.

fn restart(&mut self) -> Result<(), WaiterError>

Implementors

impl Waiter for Delay

fn restart(&mut self) -> Result<(), WaiterError>

fn start(&mut self)

fn wait(&mut self) -> Result<(), WaiterError>

impl Waiter for DelayComposer

fn restart(&mut self) -> Result<(), WaiterError>

fn start(&mut self)

fn wait(&mut self) -> Result<(), WaiterError>

impl Waiter for ExponentialBackoffWaiter

fn restart(&mut self) -> Result<(), WaiterError>

fn start(&mut self)

fn wait(&mut self) -> Result<(), WaiterError>

impl Waiter for ThrottleWaiter

fn wait(&mut self) -> Result<(), WaiterError>

impl Waiter for TimeoutWaiter

fn restart(&mut self) -> Result<(), WaiterError>

fn start(&mut self)

fn wait(&mut self) -> Result<(), WaiterError>