hko 1.13.0

Rust library for Hong Kong Observatory Open Data 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

// Copyright (c) 2023 - 2025 GreenYun Organization
// SPDX-License-Identifier: MIT

//! Rainfall in the past hour from automatic weather station
//!
//! This dataset provides rainfall amount measured at automatic weather station
//! during the 1-hour period ending at the observation time. Please note the
//! following in using this dataset:
//!
//! 1. The rainfall data in this dataset is originated from automatic weather
//!    stations. In particular, the source of rainfall data of automatic weather
//!    station “Hong Kong Observatory” in this dataset is different from the
//!    official record of Hong Kong Observatory rainfall data as given in the
//!    climatological database, other weather bulletins such as Current Weather
//!    Report, Yesterday’s Weather and Radiation Level, etc.
//! 2. The rainfall data in this dataset is provisional. Only limited data
//!    validation has been carried out. Users should take note of this
//!    limitation in using the data.
//!
//! - **HTTP Request Method**: GET
//! - **Return Type**: JSON

use chrono::{DateTime, FixedOffset};
use serde::Deserialize;

use crate::common::Lang;

/// Main response type.
#[derive(Clone, Debug, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct Response {
    /// Observation time
    pub obs_time: DateTime<FixedOffset>,

    /// Rainfall data
    pub hourly_rainfall: Vec<HourlyRainfall>,
}

/// Rainfall amount in the 1-hour period
#[derive(Clone, Debug, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct HourlyRainfall {
    /// Name of automatic weather station
    pub automatic_weather_station: String,

    /// Automatic weather station ID for this dataset
    #[serde(rename = "automaticWeatherStationID")]
    pub automatic_weather_station_id: String,

    /// An integer value of the total rainfall amount during the 1-hour period
    /// measured by the automatic weather station ending at the observation
    /// time.
    #[serde(deserialize_with = "crate::internal::deserialize::deserialize_to_rainfall_value")]
    pub value: RainfallValue,

    /// Unit of the rainfall amount
    pub unit: String,
}

#[derive(Clone, Debug)]
pub enum RainfallValue {
    /// No rainfall
    UnderMaintenance,

    /// Rainfall amount in millimeter
    Rainfall(u32),
}

/// Generate API URL from specified date.
#[must_use]
pub fn url(lang: &Lang) -> String {
    format!("https://data.weather.gov.hk/weatherAPI/opendata/hourlyRainfall.php?lang={lang}")
}

#[allow(clippy::missing_errors_doc)]
#[cfg(feature = "fetch")]
#[cfg_attr(docsrs, doc(cfg(feature = "fetch")))]
pub async fn fetch(lang: &Lang) -> anyhow::Result<Response> {
    let client = reqwest::Client::builder().build()?;

    fetch_with_client(lang, client).await
}

#[allow(clippy::missing_errors_doc)]
#[cfg(feature = "fetch")]
#[cfg_attr(docsrs, doc(cfg(feature = "fetch")))]
pub async fn fetch_with_client(lang: &Lang, client: reqwest::Client) -> anyhow::Result<Response> {
    Ok(client.get(url(lang)).send().await?.json().await?)
}

#[cfg(feature = "test")]
#[cfg(test)]
mod test;