Struct RetryDirective 

#[non_exhaustive]
pub struct RetryDirective {
    pub should_retry: bool,
    pub backoff: Option<Duration>,
    pub proxy_kind: Option<ProxyKind>,
    pub user_agent_profile: Option<String>,
    pub session_action: SessionRetryAction,
}

Owned instructions returned by a RetryStrategy.

Examples

use millipede_core::retry_strategy::{RetryDirective, SessionRetryAction};
use std::time::Duration;

let directive = RetryDirective::retry()
    .backoff(Duration::from_secs(1))
    .session_action(SessionRetryAction::Rotate);
assert!(directive.should_retry);

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

should_retry: bool

Whether the attempt should be retried.

backoff: Option<Duration>

Delay before the next attempt.

proxy_kind: Option<ProxyKind>

Proxy bucket for the next attempt.

user_agent_profile: Option<String>

User-agent profile for the next attempt.

session_action: SessionRetryAction

Session disposition for the retry.

Implementations

impl RetryDirective

pub fn retry() -> Self

Creates a directive authorizing a retry.

pub fn stop() -> Self

Creates a directive stopping retries.

pub fn backoff(self, backoff: Duration) -> Self

Sets the retry delay.

pub fn proxy_kind(self, proxy_kind: ProxyKind) -> Self

Sets the proxy bucket for the next attempt.

pub fn user_agent_profile(self, profile: impl Into<String>) -> Self

Sets the user-agent profile for the next attempt.

pub fn session_action(self, action: SessionRetryAction) -> Self

Sets the session disposition.

Trait Implementations

impl Clone for RetryDirective

fn clone(&self) -> RetryDirective

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RetryDirective

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

Formats the value using the given formatter.

impl Default for RetryDirective

fn default() -> RetryDirective

Returns the “default value” for a type.