Struct Change 

pub struct Change {
    pub bench: String,
    pub tool: String,
    pub runner: String,
    pub metric: String,
    pub base: f64,
    pub head: f64,
}

One metric, on one series, on both sides.

Fields

bench: String

tool: String

runner: String

metric: String

base: f64

head: f64

Implementations

impl Change

pub fn pct(&self) -> Option<f64>

Change as a percentage of the base, or None when the base is zero.

None rather than 0.0. Returning zero was worse than imprecise: the gate compares this against the threshold, so a rise from a zero baseline read as no change at all and passed silently, however large the head. A percentage of nothing is undefined, and the type should say so.

pub fn regressed(&self, gate_pct: f64) -> bool

Is this a regression the gate should fail on?

From a zero base, any increase counts. There is no threshold that means anything against zero, and passing would be the one outcome that is certainly wrong.

Trait Implementations

impl Clone for Change

fn clone(&self) -> Change

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Change

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

Formats the value using the given formatter.

impl PartialEq for Change

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Change