Struct Policy 

pub struct Policy {
    pub regression: BTreeMap<String, Threshold>,
    pub minimum_absolute_us: f64,
    pub targets: BTreeMap<String, BTreeMap<String, Threshold>>,
    pub budgets: Vec<Budget>,
}

The regression policy.

Fields

regression: BTreeMap<String, Threshold>

Thresholds by metric (p50, p95, p99).

minimum_absolute_us: f64

Increases under this many microseconds are noise, whatever the ratio.

targets: BTreeMap<String, BTreeMap<String, Threshold>>

Per-target allowances, keyed by the target key as bench coverage prints it, then by metric (in the file, a targets: list of target: <key> items); a metric not named here keeps the general threshold. The process-cold target spawns a process and builds the index, so the machine’s load decides most of its wall clock, and it gets more room than a request does.

budgets: Vec<Budget>

Absolute bounds, held with or without a baseline and on every host. The default policy has none: a bound is the repository’s to declare, never this crate’s.

Implementations

impl Policy

pub fn load(repo: &Repository) -> Result<Self, Error>

The policy of a repository: .ai/repo/benchmarks/rust/policy.yaml, or the default when the file does not exist.

pub fn threshold_for(&self, key: &str, metric: &str) -> Option<&Threshold>

The threshold that applies to one metric of one target: the target’s own when the policy names it, the general one otherwise.

Trait Implementations

impl Clone for Policy

fn clone(&self) -> Policy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Policy

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

Formats the value using the given formatter.

impl Default for Policy

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Policy

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for Policy

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for Policy

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Policy

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Policy