fume 0.0.2

A strongly-opinionated Rust wrapper for steam web APIs.
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

use crate::{Backend, Steam};

/// A simple trait used for authentication
/// the only reason this trait exists is to simplify Steam's impl
/// ApiKey/Unauthorize is the type state of Steam HTTP client
/// different methods are available for different type state
/// same method may return different result for different type state
pub trait Auth: Sized {
    /// returns the query parameters for steam api key
    fn auth(&self) -> Option<(&str, String)>;
    /// provided method for create steam http client from Auth types
    /// ```rust,no_run
    /// use fume::{Auth, ApiKey};
    ///
    /// let key = ApiKey::new("STEAM_DUMMY_KEY");
    /// let client = reqwest::Client::new();
    /// let steam = key.with_client(client);
    /// ```
    fn with_client<B: Backend>(self, client: B) -> Steam<Self, B> {
        Steam::with_auth_and_client(self, client)
    }
}

/// get your steam web api key from: <https://steamcommunity.com/dev/apikey>
#[derive(Clone, Debug)]
pub struct ApiKey {
    pub key: String,
}

impl ApiKey {
    /// construct a new steam api key
    pub fn new(key: impl AsRef<str>) -> Self {
        let key = key.as_ref().to_string();
        Self { key }
    }
}

impl Auth for ApiKey {
    fn auth(&self) -> Option<(&str, String)> {
        Some(("key", self.key.to_string()))
    }
}

#[derive(Clone, Debug, Default)]
pub struct Unauthorize;

impl Auth for Unauthorize {
    fn auth(&self) -> Option<(&str, String)> {
        None
    }
}