faceit 0.1.0

A Rust client library for the FACEIT Public 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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121

use crate::error::Error;
use crate::http::Client;
use crate::types::*;

/// High-level API for interacting with a specific game
///
/// This struct provides a convenient way to work with game data
/// without needing to pass the game ID to each method call.
///
/// # Examples
///
/// ```no_run
/// # use faceit::{HttpClient, http::ergonomic::Game};
/// # async fn example() -> Result<(), faceit::error::Error> {
/// let client = HttpClient::new();
/// let game = Game::new("cs2", &client);
///
/// // Get game details
/// let game_data = game.get().await?;
/// println!("Game: {}", game_data.long_label);
///
/// // Get parent game
/// let parent = game.parent().await?;
/// # Ok(())
/// # }
/// ```
pub struct Game<'a> {
    game_id: String,
    client: &'a Client,
}

impl<'a> Game<'a> {
    /// Create a new Game instance
    ///
    /// # Arguments
    /// * `game_id` - The game ID (e.g., "cs2", "csgo")
    /// * `client` - Reference to the FACEIT client
    ///
    /// # Examples
    ///
    /// ```no_run
    /// # use faceit::{HttpClient, http::ergonomic::Game};
    /// let client = HttpClient::new();
    /// let game = Game::new("cs2", &client);
    /// ```
    pub fn new(game_id: impl Into<String>, client: &'a Client) -> Self {
        Self {
            game_id: game_id.into(),
            client,
        }
    }

    /// Get the game's ID
    pub fn id(&self) -> &str {
        &self.game_id
    }

    /// Get the game's details
    ///
    /// # Examples
    ///
    /// ```no_run
    /// # use faceit::{HttpClient, http::ergonomic::Game};
    /// # async fn example() -> Result<(), faceit::error::Error> {
    /// let client = HttpClient::new();
    /// let game = Game::new("cs2", &client);
    /// let game_data = game.get().await?;
    /// println!("Game: {}", game_data.long_label);
    /// # Ok(())
    /// # }
    /// ```
    pub async fn get(&self) -> Result<crate::types::Game, Error> {
        self.client.get_game(&self.game_id).await
    }

    /// Get the parent game details (for region-specific games)
    ///
    /// # Examples
    ///
    /// ```no_run
    /// # use faceit::{HttpClient, http::ergonomic::Game};
    /// # async fn example() -> Result<(), faceit::error::Error> {
    /// let client = HttpClient::new();
    /// let game = Game::new("game-id", &client);
    /// let parent = game.parent().await?;
    /// # Ok(())
    /// # }
    /// ```
    pub async fn parent(&self) -> Result<crate::types::Game, Error> {
        self.client.get_parent_game(&self.game_id).await
    }

    /// Get game matchmakings
    ///
    /// # Arguments
    /// * `region` - Optional region filter
    /// * `offset` - Optional offset for pagination (default: 0)
    /// * `limit` - Optional limit for pagination (default: 20, max: 100)
    ///
    /// # Examples
    ///
    /// ```no_run
    /// # use faceit::{HttpClient, http::ergonomic::Game};
    /// # async fn example() -> Result<(), faceit::error::Error> {
    /// let client = HttpClient::new();
    /// let game = Game::new("cs2", &client);
    /// let matchmakings = game.matchmakings(Some("EU"), Some(0), Some(20)).await?;
    /// # Ok(())
    /// # }
    /// ```
    pub async fn matchmakings(
        &self,
        region: Option<&str>,
        offset: Option<i64>,
        limit: Option<i64>,
    ) -> Result<MatchmakingList, Error> {
        self.client
            .get_game_matchmakings(&self.game_id, region, offset, limit)
            .await
    }
}