Struct garcon::Delay

pub struct Delay { /* fields omitted */ }

A Delay struct that encapsulates a Waiter.

To use this class, first create an instance of it by either calling a method on it (like Delay::timeout) or create a builder and add multiple Waiters. Then when you’re ready to start a process that needs to wait, use the [start()] function. Every wait period, call the [wait()] function on it (it may block the thread).

Implementations

impl Delay

pub fn from(inner: Box<dyn Waiter>) -> Self

pub fn instant() -> Self

A Delay that never waits. This can hog resources, so careful.

pub fn timeout(timeout: Duration) -> Self

A Delay that doesn’t wait, but times out after a while.

pub fn count_timeout(count: u64) -> Self

A Delay that times out after waiting a certain number of times.

pub fn throttle(throttle: Duration) -> Self

A delay that waits every wait() call for a certain time.

pub fn exponential_backoff_capped(
    initial: Duration,
    multiplier: f32,
    cap: Duration
) -> Self

A delay that recalculate a wait time every wait() calls and exponentially waits. The calculation is new_wait_time = max(current_wait_time * multiplier, cap).

pub fn exponential_backoff(initial: Duration, multiplier: f32) -> Self

A delay that recalculate a wait time every wait() calls and exponentially waits. The calculation is new_wait_time = current_wait_time * multiplier. There is no limit for this backoff.

pub fn side_effect<F>(function: F) -> Self where
    F: 'static + Sync + Send + Clone + Fn() -> Result<(), WaiterError>, 

Call a function every tick, expecting some kind of side effect (e.g. a progress bar).

pub fn builder() -> DelayBuilder

Trait Implementations

impl Clone for Delay

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Waiter for Delay

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.

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

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