Struct EnergyMetadata 

pub struct EnergyMetadata {
    pub budget: Option<HirEnergyBudget>,
    pub estimated_cost: Option<f64>,
    pub estimated_power: Option<f64>,
    pub estimated_temp_delta: Option<f64>,
    pub confidence: f64,
}

Energy metadata for HIR items (functions, loops, blocks).

This struct holds both the declared budget (if any) and the compile-time estimated cost computed by the energy estimator.

Fields

budget: Option<HirEnergyBudget>

The declared energy budget from #[energy_budget(...)] attribute

estimated_cost: Option<f64>

Compile-time estimated energy cost in joules

estimated_power: Option<f64>

Estimated power consumption in watts (if determinable)

estimated_temp_delta: Option<f64>

Estimated temperature impact in Celsius

confidence: f64

Confidence level of the estimate (0.0 to 1.0) Lower values indicate more uncertainty (e.g., due to loops with unknown bounds)

Implementations

impl EnergyMetadata

pub const fn with_budget(budget: HirEnergyBudget) -> Self

Create new metadata with just a budget

pub const fn with_estimate(estimated_cost: f64, confidence: f64) -> Self

Create new metadata with an estimated cost

pub fn exceeds_budget(&self) -> bool

Check if the estimated cost exceeds the budget

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

Get the amount by which the estimate exceeds the budget (if any)

pub fn exceeds_power_budget(&self) -> bool

Check if the power estimate exceeds the budget

pub fn exceeds_temp_budget(&self) -> bool

Check if the temperature estimate exceeds the budget

pub const fn set_estimate(&mut self, cost: f64, confidence: f64)

Set the estimated cost

pub const fn has_estimate(&self) -> bool

Check if we have any estimate

Trait Implementations

impl Clone for EnergyMetadata

fn clone(&self) -> EnergyMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EnergyMetadata

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

Formats the value using the given formatter.

impl Default for EnergyMetadata

fn default() -> EnergyMetadata

Returns the “default value” for a type.

impl PartialEq for EnergyMetadata

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