carbem 0.5.0

A Rust library for retrieving carbon emission values from cloud providers
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74

use crate::providers::config::ProviderQueryConfig;
use chrono::{DateTime, Utc};
use serde::{Deserialize, Serialize};

/// Represents carbon emission data from a cloud provider
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct CarbonEmission {
    /// The cloud provider (e.g., "aws", "azure", "gcp")
    pub provider: String,

    /// The region where the emissions occurred
    pub region: String,

    /// The service or resource type
    pub service: Option<String>,

    /// Carbon emissions in kilograms of CO2 equivalent
    pub emissions_kg_co2eq: f64,

    /// The time period for which emissions are reported
    pub time_period: TimePeriod,

    /// Additional metadata
    pub metadata: Option<EmissionMetadata>,
}

/// Time period for carbon emission measurements
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct TimePeriod {
    /// Start of the measurement period
    pub start: DateTime<Utc>,

    /// End of the measurement period
    pub end: DateTime<Utc>,
}

/// Additional metadata for carbon emissions
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct EmissionMetadata {
    // Energy consumption in kWh
    pub energy_kwh: Option<f64>,

    // Grid carbon intensity (gCO2eq/kWh)
    pub grid_carbon_intensity: Option<f64>,

    // Renewable energy percentage
    pub renewable_percentage: Option<f64>,

    // Additional provider-specific data
    pub provider_data: Option<serde_json::Value>,
}

/// Configuration for querying carbon emissions
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct EmissionQuery {
    /// The cloud provider to query
    pub provider: String,

    /// The region(s) to include
    pub regions: Vec<String>,

    /// The time period to query
    pub time_period: TimePeriod,

    /// Optional: specific services to filter by
    pub services: Option<Vec<String>>,

    /// Optional: specific resources to filter by  
    pub resources: Option<Vec<String>>,

    /// Optional: provider-specific configuration (type-safe)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub provider_config: Option<ProviderQueryConfig>,
}