Struct EffectFailure 

pub struct EffectFailure { /* private fields */ }

A failed action, classified so the runtime knows whether it applied.

// The connection was refused: nothing reached the remote system.
let failure = EffectFailure::ambiguous("connection refused").request_sent(false);

Implementations

impl EffectFailure

pub fn new( class: FailureClass, source: impl Into<Box<dyn Error + Send + Sync>>, ) -> Self

A failure of class class.

pub fn transient(source: impl Into<Box<dyn Error + Send + Sync>>) -> Self

The request did not apply and may succeed if repeated.

pub fn permanent(source: impl Into<Box<dyn Error + Send + Sync>>) -> Self

The request did not apply and will not succeed if repeated.

pub fn ambiguous(source: impl Into<Box<dyn Error + Send + Sync>>) -> Self

The request may or may not have applied, e.g. a timeout after sending.

pub fn rate_limited( retry_after: Option<Duration>, source: impl Into<Box<dyn Error + Send + Sync>>, ) -> Self

The remote system asked the caller to slow down.

pub fn authentication(source: impl Into<Box<dyn Error + Send + Sync>>) -> Self

The credentials were missing or invalid.

pub fn authorization(source: impl Into<Box<dyn Error + Send + Sync>>) -> Self

The credentials were not allowed to perform the action.

pub fn validation(source: impl Into<Box<dyn Error + Send + Sync>>) -> Self

The remote system rejected the request as malformed.

pub fn request_sent(self, sent: bool) -> Self

Records whether the request reached the remote system. false turns an ambiguous failure into a transient one: nothing can have applied.

pub fn with_retry_after(self, delay: Duration) -> Self

Adds a minimum retry delay without changing whether the operation may have applied. This is scheduling advice, never evidence that a retry is safe. The runtime persists it for ambiguous outcomes too.

pub fn retry_after(&self) -> Option<Duration>

The minimum retry delay, independent of the failure’s disposition.

pub fn class(&self) -> FailureClass

The classification after taking Self::request_sent into account.

Trait Implementations

impl Debug for EffectFailure

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

Formats the value using the given formatter.

impl Display for EffectFailure

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

Formats the value using the given formatter.

impl Error for EffectFailure

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.