Struct BackoffParams 

pub struct BackoffParams {
    factor: u32,
    base: Duration,
    max: Duration,
    jitter: Ratio,
    disable: bool,
}

Fields

factor: u32

Exponential backoff exponent.

base: Duration

Exponential backoff base delay.

max: Duration

Exponential max delay.

jitter: Ratio

Exponential backoff jitter as a ratio of the backoff delay, numerator:denominator.

disable: bool

Disable retries and just fail after one failed attempt.

Implementations

impl BackoffParams

pub const fn new( base: Duration, max: Duration, factor: u32, jitter: Ratio, ) -> Self

pub fn disabled() -> Self

pub async fn retry<S, T>( &self, state: S, f: impl for<'a> Fn(&'a mut S, usize) -> BoxFuture<'a, Result<T>>, ) -> Result<T>

pub async fn retry_if<Fut, T>( &self, max_retries: u32, should_retry: impl Fn(&Error) -> bool, f: impl Fn() -> Fut, ) -> Result<T>

where Fut: Future<Output = Result<T>>,

Like retry but stops after max_retries retries and only retries when should_retry returns true for the error. The closure takes no arguments; capture any needed state in the closure itself.

pub fn backoff(&self, delay: Duration) -> Duration

Trait Implementations

impl Args for BackoffParams

fn group_id() -> Option<Id>

Report the [ArgGroup::id][crate::ArgGroup::id] for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate Self via [FromArgMatches::from_arg_matches_mut]

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate self via [FromArgMatches::update_from_arg_matches_mut]

impl Clone for BackoffParams

fn clone(&self) -> BackoffParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CommandFactory for BackoffParams

fn command<'b>() -> Command

Build a [Command] that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a [Command] that can update self.

impl Debug for BackoffParams

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

Formats the value using the given formatter.

impl Default for BackoffParams

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for BackoffParams

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromArgMatches for BackoffParams

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Ord for BackoffParams

fn cmp(&self, other: &BackoffParams) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl Parser for BackoffParams

fn parse() -> Self

Parse from std::env::args_os(), [exit][Error::exit] on error.

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, [exit][Error::exit] on error.

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, [exit][Error::exit] on error.

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.

impl PartialEq for BackoffParams

fn eq(&self, other: &BackoffParams) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for BackoffParams

fn partial_cmp(&self, other: &BackoffParams) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for BackoffParams

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for BackoffParams

impl Eq for BackoffParams

impl StructuralPartialEq for BackoffParams