Enum BreakerError 

#[non_exhaustive]
pub enum BreakerError {
    Open,
}

Unstable (feature: circuit-breaker) — may change or be removed

Error returned when the circuit is open.

#[non_exhaustive] — consumers MUST add a catch-all arm. New variants will be added in future minor releases (e.g. HalfOpen or Forced) to surface state transitions that consumers may want to react to.

A circuit-open error is NOT retryable. A breaker’s whole purpose is to STOP hammering a failing upstream. Callers that receive BreakerError MUST short-circuit the retry loop and return the error to the user. The BreakerError::is_retryable method exists to make this contract machine-checkable: integrations that map breaker errors into a provider retry loop should branch on it.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Open

The circuit is open: too many consecutive failures, or the reset timeout has not yet elapsed since the last failure.

Implementations

impl BreakerError

pub fn is_retryable(&self) -> bool

Returns false. A circuit-open error is a deliberate stop signal; retrying would burn the retry budget against a known-open circuit and is the exact behavior the breaker exists to prevent.

Trait Implementations

impl Clone for BreakerError

fn clone(&self) -> BreakerError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BreakerError

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

Formats the value using the given formatter.

impl Display for BreakerError

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

Formats the value using the given formatter.

impl Error for BreakerError

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.