bubblehearth 0.1.0

Blizzard Game Data API bindings for Rust.
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

//! Region data models and various APIs for retrieval and searching.

use serde::Deserialize;

use crate::classic::WorldOfWarcraftClassicConnector;
use crate::documents::Links;
use crate::errors::BubbleHearthResult;

/// Response from the regions endpoint, containing a list of regions
/// endpoints to retrieve further detail on the region.
#[derive(Default, Debug, Clone, PartialEq, Deserialize)]
pub struct RegionsIndex {
    /// Top-level document link to follow for a selected region ID.
    #[serde(rename = "_links")]
    pub links: Links,
    /// List of available regions and their metadata.
    pub regions: Vec<Region>,
}

/// Region metadata returned from the index endpoint.
#[derive(Default, Debug, Clone, PartialEq, Deserialize)]
pub struct Region {
    /// Endpoint for retrieving further detail about the region.
    pub href: Option<String>,
    /// Region ID.
    pub id: Option<u32>,
    /// Name of the region.
    pub name: Option<String>,
    /// Regional tag, i.e. US, KR, etc.
    pub tag: Option<String>,
}

impl<'a> WorldOfWarcraftClassicConnector<'a> {
    /// Retrieves data about all available regions.
    pub async fn get_regions(&self) -> BubbleHearthResult<RegionsIndex> {
        let url = format!(
            "https://{}.api.blizzard.com/data/wow/region/index?locale={}",
            self.client.region.get_region_abbreviation(),
            self.client.locale.get_normalized_locale(),
        );

        let regions = self
            .client
            .send_request_and_deserialize::<RegionsIndex>(url)
            .await?;

        Ok(regions)
    }

    /// Retrieves data about all available regions.
    pub async fn get_region(&self, region_id: u32) -> BubbleHearthResult<Option<Region>> {
        let url = format!(
            "https://{}.api.blizzard.com/data/wow/region/{region_id}?locale={}",
            self.client.region.get_region_abbreviation(),
            self.client.locale.get_normalized_locale(),
        );

        let region = self
            .client
            .send_request_and_optionally_deserialize::<Region>(url)
            .await?;

        Ok(region)
    }
}