Skip to main content

GatePolicy

Struct GatePolicy 

Source
pub struct GatePolicy { /* private fields */ }
Expand description

A versioned set of release requirements.

Implementations§

Source§

impl GatePolicy

Source

pub fn new(name: impl Into<String>) -> Result<Self>

Create an empty policy. Add only the checks the release requires.

Source

pub fn strict(name: impl Into<String>) -> Result<Self>

A conservative default: at least one run, perfect aggregate pass rates, no comparison regressions, and no removed cases.

Source

pub fn name(&self) -> &str

Stable policy name carried into decisions.

Source

pub fn with_minimum_runs(self, minimum: usize) -> Result<Self>

Require at least this many candidate runs.

Source

pub fn with_minimum_run_pass_rate(self, minimum: f64) -> Result<Self>

Require the aggregate run pass rate.

Source

pub fn with_minimum_case_pass_rate(self, minimum: f64) -> Result<Self>

Require the mean per-case pass rate.

Source

pub fn with_assertion_minimum( self, assertion: impl Into<String>, minimum: f64, ) -> Result<Self>

Require one named assertion to appear and meet a pass-rate floor.

Source

pub fn with_tag_minimum( self, tag: impl Into<String>, minimum: f64, ) -> Result<Self>

Require the mean pass rate of cases carrying tag.

Source

pub fn with_maximum_total_cost_usd(self, maximum: f64) -> Result<Self>

Cap the candidate experiment’s total recorded cost.

Source

pub fn with_maximum_cost_ratio(self, maximum: f64) -> Result<Self>

Cap candidate cost / baseline cost. Requires a comparison report.

Source

pub fn with_maximum_regressions(self, maximum: usize) -> Self

Cap the comparison report’s threshold breaches.

Source

pub fn with_forbid_removed_cases(self, forbid: bool) -> Self

Block when a baseline case is absent from the candidate.

Source

pub fn with_comparison_thresholds( self, thresholds: CompareThresholds, ) -> Result<Self>

Configure the pass-rate and latency thresholds used when the gate recomputes a baseline comparison.

Source

pub fn to_json(&self) -> Result<String>

Serialize as a stable, versioned JSON artifact.

Source

pub fn from_json(text: &str) -> Result<Self>

Parse and validate a policy artifact.

Trait Implementations§

Source§

impl Clone for GatePolicy

Source§

fn clone(&self) -> GatePolicy

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 GatePolicy

Source§

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

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

impl PartialEq for GatePolicy

Source§

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

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

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

Inequality operator !=. Read more
Source§

impl Serialize for GatePolicy

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for GatePolicy

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more