github 0.1.2

A Rust GitHub v3 API client.
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

/// By default and in most scenarios, `DEFAULT_BASE_URL`
/// will be the base url for requests via this Client library.
static DEFAULT_BASE_URL: &'static str = "https://api.github.com/";
/// By default and in most scenarios, `DEFAULT_BASE_URL`
/// will be the base upload url for requests via this Client library.
static DEFAULT_UPLOAD_BASE_URL: &'static str = "https://uploads.github.com/";

/// The `Client` struct represent the user agent and base URLs.
/// Functions in this library will never mutate a `Client` object
/// and for th sake of parallel processing, you should try to keep it immutable.
pub struct Client {
    /// `user_agent` represents the value given
    /// under the User-Agent key as part of
    /// the header of each request.
    pub user_agent: String,
    /// The base url for non-upload requests.
    pub base_url: String,
    /// The base url for upload requests.
    pub upload_url: String,
}

impl Client {
    /// Construct a `Client` for a custom domain, other than GitHub.
    pub fn custom(user: &str, base_url: &str, upload_url: &str) -> Client {
        Client {
            user_agent: user.to_string(),
            base_url: base_url.to_string(),
            upload_url: upload_url.to_string(),
        }
    }

    /// Construct a `Client` using the default URLs as defined by GitHub.
    pub fn new(user: &str) -> Client {
        Client::custom(user, DEFAULT_BASE_URL, DEFAULT_UPLOAD_BASE_URL)
    }
}