Struct BudgetPolicy 

pub struct BudgetPolicy {
    pub absolute_max_cu: Option<u64>,
    pub warn_at_budget_pct: Option<f64>,
    pub max_regression_pct: Option<f64>,
    pub max_regression_units: Option<u64>,
    pub min_margin_pct: Option<f64>,
    pub max_cpi_count: Option<u32>,
    pub max_cpi_depth: Option<u32>,
    pub max_unattributed_pct: Option<f64>,
    pub instrumentation_overhead_warn_pct: Option<f64>,
}

A budget policy attached to a scenario (or used as a project default).

Fields

absolute_max_cu: Option<u64>

Absolute maximum compute units. Exceeding this is a hard Fail.

warn_at_budget_pct: Option<f64>

Warn once consumption reaches this percentage of absolute_max_cu.

max_regression_pct: Option<f64>

Maximum tolerated regression versus baseline, as a percentage.

max_regression_units: Option<u64>

Maximum tolerated regression versus baseline, in absolute units.

min_margin_pct: Option<f64>

Minimum required margin below absolute_max_cu, as a percentage.

max_cpi_count: Option<u32>

Maximum number of CPI invocations.

max_cpi_depth: Option<u32>

Maximum CPI invoke depth.

max_unattributed_pct: Option<f64>

Maximum percentage of CU left unattributed to a scope before warning.

instrumentation_overhead_warn_pct: Option<f64>

Warn when instrumentation overhead exceeds this percentage.

Implementations

impl BudgetPolicy

pub fn merged_with(&self, override_with: &BudgetPolicy) -> BudgetPolicy

Overlay override_with onto self: any field set in the override wins.

Trait Implementations

impl Clone for BudgetPolicy

fn clone(&self) -> BudgetPolicy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BudgetPolicy

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

Formats the value using the given formatter.

impl Default for BudgetPolicy

fn default() -> BudgetPolicy

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for BudgetPolicy

where BudgetPolicy: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for BudgetPolicy

fn eq(&self, other: &BudgetPolicy) -> 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 BudgetPolicy

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 BudgetPolicy