steam-rs 0.5.1

Safe Rust bindings for the Steam Web 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

//! Implements the `GetNumberOfCurrentPlayers` endpoint

use serde::{Deserialize, Serialize};

use crate::{
    errors::{ErrorHandle, SteamUserStatsError},
    macros::{do_http, gen_args},
    Steam, BASE,
};

use super::INTERFACE;

const ENDPOINT: &str = "GetNumberOfCurrentPlayers";
const VERSION: &str = "1";

#[derive(Debug, Clone, Deserialize, Serialize)]
struct Wrapper {
    response: Response,
}

#[derive(Debug, Clone, Deserialize, Serialize)]
struct Response {
    player_count: Option<u64>,
    result: u8,
}

impl Steam {
    /// Retrieves the number of current players for a game.
    ///
    /// # Arguments
    ///
    /// * `appid` - The ID of the application (game) for which to retrieve the number of current players.
    pub async fn get_number_of_current_players(
        &self,
        appid: u32,
    ) -> Result<u64, SteamUserStatsError> {
        let key = &self.api_key.clone();
        let args = gen_args!(key, appid);
        let url = format!("{BASE}/{INTERFACE}/{ENDPOINT}/v{VERSION}/?{args}");

        let wrapper = do_http!(
            url,
            Wrapper,
            ErrorHandle,
            SteamUserStatsError::GetNumberOfCurrentPlayers
        );

        match wrapper.response.result {
            1 => Ok(wrapper.response.player_count.unwrap()),
            _ => Err(SteamUserStatsError::GetNumberOfCurrentPlayers(
                "App not found.".to_string(),
            )),
        }
    }
}