pub struct GateOptions {
pub fail_threshold: Option<usize>,
pub must_fail: Vec<String>,
pub show_all: bool,
}Expand description
Re-export of the comparison-policy types so downstream crates
using ktstr::cli as their public surface don’t need to reach
into the internal ktstr::stats module (which is pub(crate) —
see lib.rs — and therefore not a stable public path). The
policy is the only item in stats that a CLI or external
consumer constructs directly; every other item is internal
plumbing reached via cli::compare_partitions.
Operator-level perf-delta failure gate + render options, layered on top
of the per-metric significance policy (which decides WHICH deltas are
confident regressions). These decide HOW MANY / WHICH-NAMED confident
regressions fail the run, and whether stable/noisy rows render.
Fields§
§fail_threshold: Option<usize>Fail iff at least this many confident regressions occur. None
means 5 — a handful of regressions is tolerated as run-to-run noise
and the run fails only once several metrics regress; pass
--fail-threshold 1 for fail-on-any. Some(0) disables the count
gate entirely — only Self::must_fail can then fail the run.
must_fail: Vec<String>Metric registry names that fail the run if ANY of them regresses, regardless of the count gate (ORed on top). Caller-validated against the metric registry.
show_all: boolRender every compared metric row (stable + noisy included) on the
--noise-adjust table instead of only the meaningful ones.
Display-only — never affects the gate.
Trait Implementations§
Source§impl Clone for GateOptions
impl Clone for GateOptions
Source§fn clone(&self) -> GateOptions
fn clone(&self) -> GateOptions
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for GateOptions
impl Debug for GateOptions
Source§impl Default for GateOptions
impl Default for GateOptions
Source§fn default() -> GateOptions
fn default() -> GateOptions
Auto Trait Implementations§
impl Freeze for GateOptions
impl RefUnwindSafe for GateOptions
impl Send for GateOptions
impl Sync for GateOptions
impl Unpin for GateOptions
impl UnwindSafe for GateOptions
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more