Struct twitchchat::RetryStrategy

pub struct RetryStrategy;

Some common retry strategies.

These are used with [Runner::run_with_retry][retry].

You can provide your own by simplying having an async function with the same signature.

That is async fn(result: Result<Status, Error>) -> Result<bool, Error>.

Return one of:

• Ok(true) to cause it to reconnect.
• Ok(false) will gracefully exit with Ok(Status::Eof)
• Err(err) will return that error

Implementations

impl RetryStrategy

pub async fn immediately(result: Result<Status, Error>) -> Result<bool, Error>

This is supported on feature="tokio" only.

Reconnect immediately unless the Status was Canceled

pub async fn on_timeout(result: Result<Status, Error>) -> Result<bool, Error>

This is supported on feature="tokio" only.

Retries if Status was a Timeout, otherwise return the Err or false (to stop the connection loop).

pub async fn on_error(result: Result<Status, Error>) -> Result<bool, Error>

This is supported on feature="tokio" only.

Retries if the Result was an error

Trait Implementations

impl Clone for RetryStrategy

fn clone(&self) -> RetryStrategy

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for RetryStrategy

impl Debug for RetryStrategy

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Default for RetryStrategy

fn default() -> RetryStrategy

Returns the "default value" for a type.