Struct CircuitBreakerLayer 

pub struct CircuitBreakerLayer<P> { /* private fields */ }

Available on crate feature circuit-breaker only.

Layer that wraps services in a CircuitBreaker.

Construct with CircuitBreakerLayer::new for the standard ConsecutiveFailures policy, or with CircuitBreakerLayer::with_policy to supply any custom CircuitPolicy.

Implementations

impl CircuitBreakerLayer<ConsecutiveFailures>

pub fn new( failure_threshold: usize, success_threshold: f64, timeout: Duration, ) -> Self

Create a layer using the built-in ConsecutiveFailures policy.

• failure_threshold: consecutive failures before the circuit opens.
• success_threshold: fraction of probes (0.0–1.0) that must succeed during HalfOpen before the circuit closes again.
• timeout: how long to stay open before sending the first probe.

impl<P: CircuitPolicy + Clone> CircuitBreakerLayer<P>

pub fn with_policy(policy: P) -> Self

Create a layer using a custom CircuitPolicy.

Example

use tower::circuit_breaker::{CircuitBreakerLayer, ConsecutiveFailures};
use std::time::Duration;

// Using the built-in policy explicitly:
let policy = ConsecutiveFailures::new(5, 0.8, Duration::from_secs(30));
let layer  = CircuitBreakerLayer::with_policy(policy);

// Or bring your own:
let layer = CircuitBreakerLayer::with_policy(MyLatencyPolicy::new());

Trait Implementations

impl<P: Clone> Clone for CircuitBreakerLayer<P>

fn clone(&self) -> CircuitBreakerLayer<P>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<P: Debug> Debug for CircuitBreakerLayer<P>

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

Formats the value using the given formatter.

impl<S, P: CircuitPolicy + Clone> Layer<S> for CircuitBreakerLayer<P>

type Service = CircuitBreaker<S, P>

The wrapped service

fn layer(&self, inner: S) -> Self::Service

Wrap the given service with the middleware, returning a new service that has been decorated with the middleware.