pub struct ExponentialBackoffBuilder<C> { /* private fields */ }Expand description
Builder for ExponentialBackoff.
TODO: Example
Implementations§
Source§impl<C> ExponentialBackoffBuilder<C>
impl<C> ExponentialBackoffBuilder<C>
pub fn new() -> ExponentialBackoffBuilder<C>
Sourcepub fn with_initial_interval(
&mut self,
initial_interval: Duration,
) -> &mut ExponentialBackoffBuilder<C>
pub fn with_initial_interval( &mut self, initial_interval: Duration, ) -> &mut ExponentialBackoffBuilder<C>
The initial retry interval.
Sourcepub fn with_randomization_factor(
&mut self,
randomization_factor: f64,
) -> &mut ExponentialBackoffBuilder<C>
pub fn with_randomization_factor( &mut self, randomization_factor: f64, ) -> &mut ExponentialBackoffBuilder<C>
The randomization factor to use for creating a range around the retry interval.
A randomization factor of 0.5 results in a random period ranging between 50% below and 50% above the retry interval.
Sourcepub fn with_multiplier(
&mut self,
multiplier: f64,
) -> &mut ExponentialBackoffBuilder<C>
pub fn with_multiplier( &mut self, multiplier: f64, ) -> &mut ExponentialBackoffBuilder<C>
The value to multiply the current interval with for each retry attempt.
Sourcepub fn with_max_interval(
&mut self,
max_interval: Duration,
) -> &mut ExponentialBackoffBuilder<C>
pub fn with_max_interval( &mut self, max_interval: Duration, ) -> &mut ExponentialBackoffBuilder<C>
The maximum value of the back off period. Once the retry interval reaches this value it stops increasing.
Sourcepub fn with_max_elapsed_time(
&mut self,
max_elapsed_time: Option<Duration>,
) -> &mut ExponentialBackoffBuilder<C>
pub fn with_max_elapsed_time( &mut self, max_elapsed_time: Option<Duration>, ) -> &mut ExponentialBackoffBuilder<C>
The maximum elapsed time after instantiating ExponentialBackfff or calling
reset after which next_backoff returns None.
pub fn build(&self) -> ExponentialBackoff<C>
Trait Implementations§
Source§impl<C> Debug for ExponentialBackoffBuilder<C>where
C: Debug,
impl<C> Debug for ExponentialBackoffBuilder<C>where
C: Debug,
Source§impl<C> Default for ExponentialBackoffBuilder<C>
impl<C> Default for ExponentialBackoffBuilder<C>
Source§fn default() -> ExponentialBackoffBuilder<C>
fn default() -> ExponentialBackoffBuilder<C>
Auto Trait Implementations§
impl<C> Freeze for ExponentialBackoffBuilder<C>
impl<C> RefUnwindSafe for ExponentialBackoffBuilder<C>where
C: RefUnwindSafe,
impl<C> Send for ExponentialBackoffBuilder<C>where
C: Send,
impl<C> Sync for ExponentialBackoffBuilder<C>where
C: Sync,
impl<C> Unpin for ExponentialBackoffBuilder<C>where
C: Unpin,
impl<C> UnwindSafe for ExponentialBackoffBuilder<C>where
C: UnwindSafe,
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);