Struct AttemptTimeoutOption 

pub struct AttemptTimeoutOption { /* private fields */ }

Per-attempt timeout settings.

A timeout option combines the timeout duration with the policy selected when an attempt exceeds that duration.

Implementations

impl AttemptTimeoutOption

pub fn new(timeout: Duration, policy: AttemptTimeoutPolicy) -> Self

Creates a per-attempt timeout option.

Parameters

• timeout: Maximum duration for one attempt.
• policy: Action selected when the timeout is reached.

Returns

A timeout option. Call AttemptTimeoutOption::validate before using values that come from configuration or user input.

pub fn retry(timeout: Duration) -> Self

Creates a timeout option that retries timed-out attempts.

Parameters

• timeout: Maximum duration for one attempt.

Returns

A timeout option using AttemptTimeoutPolicy::Retry.

pub fn abort(timeout: Duration) -> Self

Creates a timeout option that aborts on the first timed-out attempt.

Parameters

• timeout: Maximum duration for one attempt.

Returns

A timeout option using AttemptTimeoutPolicy::Abort.

pub fn timeout(&self) -> Duration

Returns the timeout duration.

Returns

Maximum duration allowed for one attempt.

pub fn policy(&self) -> AttemptTimeoutPolicy

Returns the timeout policy.

Returns

Policy selected when one attempt times out.

pub fn with_policy(self, policy: AttemptTimeoutPolicy) -> Self

Returns a copy with another timeout policy.

Parameters

• policy: Replacement timeout policy.

Returns

A timeout option with the same duration and the new policy.

pub fn validate(&self) -> Result<(), String>

Validates this timeout option.

Returns

Ok(()) when the timeout can be used by an executor.

Errors

Returns an error when the timeout duration is zero.

Trait Implementations

impl Clone for AttemptTimeoutOption

fn clone(&self) -> AttemptTimeoutOption

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AttemptTimeoutOption

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AttemptTimeoutOption

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for AttemptTimeoutOption

fn eq(&self, other: &AttemptTimeoutOption) -> 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 Serialize for AttemptTimeoutOption

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 AttemptTimeoutOption

impl Eq for AttemptTimeoutOption

impl StructuralPartialEq for AttemptTimeoutOption