misc-deps
/
inth-oauth2
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Add a bit of documentation

This commit is contained in:
Curtis McEnroe 2015-11-28 04:20:40 -05:00
parent bb4a216c9d
commit 9e45fd6b75
1 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
src/client.rs
View File

@ -1,8 +1,8 @@
//! OAuth2 client. //! OAuth 2.0 client.
use url::{Url, ParseResult}; use url::{Url, ParseResult};
/// OAuth2 client. /// OAuth 2.0 client.
pub struct Client { pub struct Client {
auth_uri: String, auth_uri: String,
token_uri: String, token_uri: String,
@ -13,6 +13,7 @@ pub struct Client {
} }
impl Client { impl Client {
/// Creates an OAuth 2.0 client.
pub fn new<S: Into<String>>( pub fn new<S: Into<String>>(
auth_uri: S, auth_uri: S,
token_uri: S, token_uri: S,
@ -30,6 +31,7 @@ impl Client {
} }
} }
/// Creates a Google OAuth 2.0 client.
pub fn google<S: Into<String>>( pub fn google<S: Into<String>>(
client_id: S, client_id: S,
client_secret: S, client_secret: S,
@ -45,6 +47,7 @@ impl Client {
} }
} }
/// Constructs an authorization request URI.
pub fn auth_uri(&self, scope: Option<&str>, state: Option<&str>) -> ParseResult<String> { pub fn auth_uri(&self, scope: Option<&str>, state: Option<&str>) -> ParseResult<String> {
let mut uri = try!(Url::parse(&self.auth_uri)); let mut uri = try!(Url::parse(&self.auth_uri));