Struct sgip_signal::Forecast

pub struct Forecast {
    pub region: GridRegion,
    pub generated_at: DateTime<Utc>,
    pub data: BTreeMap<DateTime<Utc>, f64>,
}

A forecast of future MOERs.

To get the Moer this forecast predicts at a given time, use Forecast::at.

Fields

region: GridRegion

The grid region for the forecast.

generated_at: DateTime<Utc>

The time when the forecast was generated.

data: BTreeMap<DateTime<Utc>, f64>

The forecast itself, mapping the start time of each interval to the emissions rate, in kg CO2 / kWh.

Implementations

impl Forecast

pub fn at(&self, time: DateTime<Utc>) -> Option<Moer>

Return the forecasted Moer for the given time, or None if the time is not included in the forecast.

Note: because the forecast data returned by the SGIP Signal API does not include explicit end-times, this method treats the start of the next time interval as the end of the previous one, and therefore treats the start of the last time interval as the end of the forecast range.

pub fn moers(&self) -> impl Iterator<Item = Moer> + '_

Iterate over the Moers predicted by this forecast.

Trait Implementations

impl Clone for Forecast

fn clone(&self) -> Forecast

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Forecast

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Forecast

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.