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

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

//! Gregorian-Lunar calendar conversion table
//!
//! - **HTTP Request Method**: GET
//! - **Return Type**: JSON

use chrono::{Datelike, NaiveDate};
use serde::Deserialize;

use crate::error::APIRequestError;

/// Main response type.
#[derive(Clone, Debug, Deserialize)]
#[serde(rename_all = "PascalCase")]
pub struct Response {
    /// Lunar year, Gan-Zhi and Zodiac (in traditional Chinese)
    pub lunar_year: String,

    /// Lunar date (in traditional Chinese)
    pub lunar_date: String,
}

/// Generate API URL from specified date.
///
/// # Errors
///
/// Returns [`APIRequestError`] if specified date is not illegal or out of
/// range.
pub fn url(date: NaiveDate) -> Result<String, APIRequestError> {
    if !matches!(date.year(), 2023..=2027) {
        return Err(APIRequestError("date must be between 2023-01-01 and 2024-12-31".into()));
    }

    Ok(format!(
        "https://data.weather.gov.hk/weatherAPI/opendata/lunardate.php?date={}",
        date.format("%Y-%m-%d")
    ))
}

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

    fetch_with_client(date, client).await
}

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

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