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

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

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

impl<'a> Match<'a> {
    /// Create a new Match instance
    ///
    /// # Arguments
    /// * `match_id` - The FACEIT match ID
    /// * `client` - Reference to the FACEIT client
    ///
    /// # Examples
    ///
    /// ```no_run
    /// # use faceit::{HttpClient, http::ergonomic::Match};
    /// let client = HttpClient::new();
    /// let match_obj = Match::new("match-id-here", &client);
    /// ```
    pub fn new(match_id: impl Into<String>, client: &'a Client) -> Self {
        Self {
            match_id: match_id.into(),
            client,
        }
    }

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

    /// Get the match's details
    ///
    /// # Examples
    ///
    /// ```no_run
    /// # use faceit::{HttpClient, http::ergonomic::Match};
    /// # async fn example() -> Result<(), faceit::error::Error> {
    /// let client = HttpClient::new();
    /// let match_obj = Match::new("match-id-here", &client);
    /// let match_data = match_obj.get().await?;
    /// println!("Match: {}", match_data.match_id);
    /// # Ok(())
    /// # }
    /// ```
    pub async fn get(&self) -> Result<crate::types::Match, Error> {
        self.client.get_match(&self.match_id).await
    }

    /// Get the match's statistics
    ///
    /// # Examples
    ///
    /// ```no_run
    /// # use faceit::{HttpClient, http::ergonomic::Match};
    /// # async fn example() -> Result<(), faceit::error::Error> {
    /// let client = HttpClient::new();
    /// let match_obj = Match::new("match-id-here", &client);
    /// let stats = match_obj.stats().await?;
    /// println!("Rounds: {}", stats.rounds.len());
    /// # Ok(())
    /// # }
    /// ```
    pub async fn stats(&self) -> Result<crate::types::MatchStats, Error> {
        self.client.get_match_stats(&self.match_id).await
    }
}