rustyhub 0.3.0

A client for the Github v3 API
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

// Copyright 2016 Alex Frappier Lachapelle
//
// Licensed under the Apache License, Version 2.0, <LICENSE-APACHE or
// http://apache.org/licenses/LICENSE-2.0> or the MIT license <LICENSE-MIT or
// http://opensource.org/licenses/MIT>, at your option. This file may not be
// copied, modified, or distributed except according to those terms.

//TODO?: Move to mod.rs

//! # Auth
//!
//! Represents the different methods of authentication
//! that can be used for the API

#[derive(Clone, Debug, PartialEq)]
pub enum Auth {
    /// Use the Github API un-authenticated
    NoAuth,
    /// Use the Github API authenticated with an OAuth2
    /// token.
    /// ## Parameters
    /// * OAuth token.
    OAuth2Token(String),
    /// Use the Github API authenticated with an OAuth2
    /// key/secret.
    /// ## Parameters
    /// * Client ID.
    /// * Client secret.
    OAuth2KeySecret(String, String),
    /// Use the Github API authenticated with a username
    /// password and optionally with a a two-factor
    /// OTP
    /// # Parameters
    /// * Username
    /// * Password
    /// * Optional OTP
    Basic(String, String, Option<String>)
}