leetify 0.1.1

A Rust client library for the Leetify Public CS 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

use crate::client::Client;
use crate::error::Error;
use crate::types::{Id, MatchDetailsResponse, ProfileResponse};

/// High-level API for interacting with a specific player
///
/// This struct provides a convenient way to work with player data
/// without needing to pass the player id to each method call.
///
/// # Examples
///
/// ```no_run
/// # use leetify::{Client, Player, Id};
/// # async fn example() -> Result<(), leetify::Error> {
/// let client = Client::new();
/// let player = Player::new(Id::Steam64("76561198283431555".into()), &client);
///
/// // Get profile
/// let profile = player.profile().await?;
/// println!("Player: {}", profile.name);
///
/// // Get matches
/// let matches = player.matches().await?;
/// println!("Found {} matches", matches.len());
/// # Ok(())
/// # }
/// ```
pub struct Player<'a> {
    id: Id,
    client: &'a Client,
}

impl<'a> Player<'a> {
    /// Create a new Player instance
    ///
    /// # Arguments
    /// * `id` - The player id (Steam64 ID or Leetify ID)
    /// * `client` - Reference to the Leetify client
    ///
    /// # Examples
    ///
    /// ```no_run
    /// # use leetify::{Client, Player, Id};
    /// let client = Client::new();
    /// let player = Player::new(Id::Steam64("76561198283431555".into()), &client);
    /// ```
    pub fn new(id: impl Into<Id>, client: &'a Client) -> Self {
        Self {
            id: id.into(),
            client,
        }
    }

    /// Get the player's id
    pub fn id(&self) -> &Id {
        &self.id
    }

    /// Get the player's profile
    ///
    /// # Examples
    ///
    /// ```no_run
    /// # use leetify::{Client, Player, Id};
    /// # async fn example() -> Result<(), leetify::Error> {
    /// let client = Client::new();
    /// let player = Player::new(Id::Steam64("76561198283431555".into()), &client);
    /// let profile = player.profile().await?;
    /// println!("Player: {}", profile.name);
    /// # Ok(())
    /// # }
    /// ```
    pub async fn profile(&self) -> Result<ProfileResponse, Error> {
        self.client.get_profile(self.id.clone()).await
    }

    /// Get the player's match history
    ///
    /// # Examples
    ///
    /// ```no_run
    /// # use leetify::{Client, Player, Id};
    /// # async fn example() -> Result<(), leetify::Error> {
    /// let client = Client::new();
    /// let player = Player::new(Id::Steam64("76561198283431555".into()), &client);
    /// let matches = player.matches().await?;
    /// println!("Found {} matches", matches.len());
    /// # Ok(())
    /// # }
    /// ```
    pub async fn matches(&self) -> Result<Vec<MatchDetailsResponse>, Error> {
        self.client.get_profile_matches(self.id.clone()).await
    }
}

#[cfg(feature = "player")]
impl Client {
    /// Create a Player instance for the given id
    ///
    /// This is a convenience method that creates a Player instance
    /// using this client.
    ///
    /// # Examples
    ///
    /// ```no_run
    /// # use leetify::{Client, Id};
    /// # async fn example() -> Result<(), leetify::Error> {
    /// let client = Client::new();
    /// let player = client.player(Id::Steam64("76561198283431555".into()));
    ///
    /// let profile = player.profile().await?;
    /// let matches = player.matches().await?;
    /// # Ok(())
    /// # }
    /// ```
    pub fn player(&self, id: impl Into<Id>) -> crate::player::Player<'_> {
        crate::player::Player::new(id, self)
    }
}