Struct Guardrail 

pub struct Guardrail {
    pub alpha: f64,
    pub delta: f64,
    pub window: usize,
    pub min_n: usize,
    pub action: GuardrailAction,
}

Guardrail settings.

Fields

alpha: f64

The served-failure target being defended, in (0, 1).

delta: f64

Confidence parameter for the bound, in (0, 1). Matches the delta used to earn the published guarantee, so the guardrail defends the same number that was advertised.

window: usize

Trailing window of resolved outcomes to judge over.

min_n: usize

Never act on fewer resolved samples than this.

action: GuardrailAction

What to do on breach.

Implementations

impl Guardrail

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

Whether this configuration is coherent.

Errors

If alpha/delta are outside (0, 1), the window is zero, or min_n exceeds the window (which would make the guardrail unable to ever act — a silently inert guard is worse than none, because an operator believes they are protected).

Trait Implementations

impl Clone for Guardrail

fn clone(&self) -> Guardrail

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Guardrail

impl Debug for Guardrail

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Guardrail

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Guardrail

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Guardrail