summaryrefslogtreecommitdiff
path: root/src/oauth2.rs
diff options
context:
space:
mode:
authorShaun Taheri <shaun@advancedtelematic.com>2016-08-19 10:12:07 +0200
committerShaun Taheri <shaun@advancedtelematic.com>2016-08-23 18:00:28 +0200
commitba122a6fa07fed1eca61d2fc6c4fd5eebf50449e (patch)
tree31646764e34532f2c616ded6c577d4b5328a41f9 /src/oauth2.rs
parent5debba21cc671d19c176369b849b5cad9c611071 (diff)
downloadrvi_sota_client-ba122a6fa07fed1eca61d2fc6c4fd5eebf50449e.tar.gz
Add documentation to public functions
Diffstat (limited to 'src/oauth2.rs')
-rw-r--r--src/oauth2.rs1
1 files changed, 1 insertions, 0 deletions
diff --git a/src/oauth2.rs b/src/oauth2.rs
index 3c1da05..bcfbe4c 100644
--- a/src/oauth2.rs
+++ b/src/oauth2.rs
@@ -4,6 +4,7 @@ use datatype::{AccessToken, Error, Url};
use http::Client;
+/// Authenticate with the specified OAuth2 server to retrieve a new `AccessToken`.
pub fn authenticate(server: Url, client: &Client) -> Result<AccessToken, Error> {
debug!("authenticating at {}", server);
let resp_rx = client.post(server, None);