openmeteo-rs 1.0.0

Rust client for the Open-Meteo weather API.
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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141

use std::borrow::Cow;

use crate::query::AsApiStr;

/// Model selector for flood forecast requests.
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
#[non_exhaustive]
pub enum FloodModel {
    /// GloFAS v4 seamless flood model.
    GlofasV4Seamless,
    /// GloFAS v4 forecast model.
    GlofasV4Forecast,
    /// GloFAS v4 consolidated historical model.
    GlofasV4Consolidated,
    /// GloFAS v3 seamless flood model.
    GlofasV3Seamless,
    /// GloFAS v3 forecast model.
    GlofasV3Forecast,
    /// GloFAS v3 consolidated historical model.
    GlofasV3Consolidated,
    /// Exact Open-Meteo flood model token not yet represented by this enum.
    ///
    /// The token is passed through unchanged and is not validated by the crate.
    Other(Cow<'static, str>),
}

impl FloodModel {
    /// Creates an exact Open-Meteo flood model token not yet represented by this enum.
    ///
    /// The token is passed through unchanged and is not validated by the crate.
    pub fn other(token: impl Into<Cow<'static, str>>) -> Self {
        Self::Other(token.into())
    }
}

impl AsApiStr for FloodModel {
    fn as_api_str(&self) -> Cow<'static, str> {
        match self {
            Self::GlofasV4Seamless => Cow::Borrowed("seamless_v4"),
            Self::GlofasV4Forecast => Cow::Borrowed("forecast_v4"),
            Self::GlofasV4Consolidated => Cow::Borrowed("consolidated_v4"),
            Self::GlofasV3Seamless => Cow::Borrowed("seamless_v3"),
            Self::GlofasV3Forecast => Cow::Borrowed("forecast_v3"),
            Self::GlofasV3Consolidated => Cow::Borrowed("consolidated_v3"),
            Self::Other(token) => token.clone(),
        }
    }
}

/// Daily variables for flood forecast requests.
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
#[non_exhaustive]
pub enum FloodDailyVar {
    /// Daily river discharge.
    RiverDischarge,
    /// Ensemble mean river discharge.
    RiverDischargeMean,
    /// Ensemble median river discharge.
    RiverDischargeMedian,
    /// Ensemble maximum river discharge.
    RiverDischargeMax,
    /// Ensemble minimum river discharge.
    RiverDischargeMin,
    /// Ensemble 25th percentile river discharge.
    RiverDischargeP25,
    /// Ensemble 75th percentile river discharge.
    RiverDischargeP75,
    /// Exact Open-Meteo flood daily variable token not yet represented by this enum.
    ///
    /// The token is passed through unchanged and is not validated by the crate.
    Other(Cow<'static, str>),
}

impl FloodDailyVar {
    /// Creates an exact Open-Meteo flood daily variable token not yet represented by this enum.
    ///
    /// The token is passed through unchanged and is not validated by the crate.
    pub fn other(token: impl Into<Cow<'static, str>>) -> Self {
        Self::Other(token.into())
    }
}

impl AsApiStr for FloodDailyVar {
    fn as_api_str(&self) -> Cow<'static, str> {
        match self {
            Self::RiverDischarge => Cow::Borrowed("river_discharge"),
            Self::RiverDischargeMean => Cow::Borrowed("river_discharge_mean"),
            Self::RiverDischargeMedian => Cow::Borrowed("river_discharge_median"),
            Self::RiverDischargeMax => Cow::Borrowed("river_discharge_max"),
            Self::RiverDischargeMin => Cow::Borrowed("river_discharge_min"),
            Self::RiverDischargeP25 => Cow::Borrowed("river_discharge_p25"),
            Self::RiverDischargeP75 => Cow::Borrowed("river_discharge_p75"),
            Self::Other(token) => token.clone(),
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn flood_model_tokens_are_formatted() {
        assert_eq!(FloodModel::GlofasV4Seamless.as_api_str(), "seamless_v4");
        assert_eq!(FloodModel::GlofasV4Forecast.as_api_str(), "forecast_v4");
        assert_eq!(
            FloodModel::GlofasV4Consolidated.as_api_str(),
            "consolidated_v4"
        );
        assert_eq!(FloodModel::GlofasV3Seamless.as_api_str(), "seamless_v3");
        assert_eq!(FloodModel::GlofasV3Forecast.as_api_str(), "forecast_v3");
        assert_eq!(
            FloodModel::GlofasV3Consolidated.as_api_str(),
            "consolidated_v3"
        );
        assert_eq!(
            FloodModel::other("custom_flood_model").as_api_str(),
            "custom_flood_model"
        );
    }

    #[test]
    fn flood_daily_tokens_are_formatted() {
        assert_eq!(
            FloodDailyVar::RiverDischarge.as_api_str(),
            "river_discharge"
        );
        assert_eq!(
            FloodDailyVar::RiverDischargeMean.as_api_str(),
            "river_discharge_mean"
        );
        assert_eq!(
            FloodDailyVar::RiverDischargeP75.as_api_str(),
            "river_discharge_p75"
        );
        assert_eq!(
            FloodDailyVar::other("custom_flood_var").as_api_str(),
            "custom_flood_var"
        );
    }
}