Skip to main content

BreakerPolicy

Struct BreakerPolicy 

Source
pub struct BreakerPolicy {
    pub failures: Option<NonZeroU64>,
    pub cooldown: DurationMs,
    pub window: Option<DurationMs>,
    pub failure_rate: Option<f64>,
    pub min_calls: Option<NonZeroU32>,
}
Expand description

breaker = { failures, cooldown, window, failure_rate, min_calls }.

Two modes per the frozen schema ($defs/breaker), enforced identically by the real core and every stub — normative rules in conformance/README.md:

  • count mode: selected when failures is set (or no rate knob is set; failures then defaults to 5) — failures consecutive terminal failures open the breaker.
  • rate mode: selected when failures is absent and both window and failure_rate are set — trips when the trailing window holds at least min_calls outcomes (default 10) with failed/total >= failure_rate.

A rate-mode knob without both window and failure_rate (and without failures) is rejected at deserialize time (KEEL-E001): a half-configured mode must fail loudly, never silently degrade to count-mode defaults.

Fields§

§failures: Option<NonZeroU64>

Count-mode threshold. None means “not set by the user” — see BreakerPolicy::mode for how that selects the mode.

§cooldown: DurationMs§window: Option<DurationMs>§failure_rate: Option<f64>§min_calls: Option<NonZeroU32>

Implementations§

Source§

impl BreakerPolicy

Source

pub const DEFAULT_FAILURES: NonZeroU64

Schema default for count mode’s failures.

Source

pub const DEFAULT_MIN_CALLS: NonZeroU32

Schema default for rate mode’s min_calls.

Source

pub fn mode(&self) -> BreakerMode

The mode this policy selects (schema: “Setting failures selects count mode”), with defaults applied. Deserialization already rejected half-configured rate mode, so window+failure_rate are either both present or irrelevant here.

Source

pub fn has_inert_rate_knobs(&self) -> bool

Whether count mode was selected while rate-mode knobs are present — those knobs are inert (the schema’s precedence), which callers may want to surface loudly rather than leave silent.

Trait Implementations§

Source§

impl Clone for BreakerPolicy

Source§

fn clone(&self) -> BreakerPolicy

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for BreakerPolicy

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for BreakerPolicy

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for BreakerPolicy

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for BreakerPolicy

Source§

fn eq(&self, other: &BreakerPolicy) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for BreakerPolicy

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.