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
56
57
58
59
60

//! # Implements the `GetUserGroupList` endpoint

use serde::Deserialize;
use serde_json::{from_value, Value};

use crate::{
    errors::{ErrorHandle, SteamUserError},
    macros::do_http,
    steam_id::SteamId,
    Steam, BASE,
};

use super::INTERFACE;

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

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

#[derive(Deserialize, Debug, Clone)]
pub struct Response {
    /// Boolean indicating if request was successful.
    pub success: bool,

    /// Error message that is given only if request was unsuccessful
    pub error: Option<String>,

    /// A vector of `Group` objects, representing the groups that the user is a member of
    pub groups: Vec<Group>,
}

/// Represents a Steam group
#[derive(Deserialize, Debug, Clone)]
pub struct Group {
    /// The group's ID
    pub gid: String,
}

impl Steam {
    /// Get a list of groups that a user is a member of.
    ///
    /// # Arguments
    ///
    /// * `steam_id` - The SteamID of the user.
    pub async fn get_user_group_list(&self, steam_id: SteamId) -> Result<Response, SteamUserError> {
        let query = format!("?key={}&steamid={}", &self.api_key, steam_id);
        let url = format!("{}/{}/{}/v{}/{}", BASE, INTERFACE, ENDPOINT, VERSION, query);
        println!("{}", url);
        let json = do_http!(url, Value, ErrorHandle, SteamUserError::GetUserGroupList);
        let wrapper: Wrapper = ErrorHandle!(
            from_value(json.to_owned()),
            SteamUserError::GetUserGroupList
        );

        Ok(wrapper.response)
    }
}