chris/ruwuma
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add more detailed documentation for Client::log_in

Browse Source
This commit is contained in:
Jonas Platte 2017-07-09 21:46:45 +10:00
parent 61d848d2b5
commit fcd6985618
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
src/lib.rs
View File

@ -100,7 +100,11 @@ where
} }
} }
/// Log in to the homeserver with a username and password. /// Log in with a username and password.
///
/// In contrast to api::r0::session::login::call(), this method stores the
/// session data returned by the endpoint in this client, instead of
/// returning it.
pub fn log_in<'a>(&'a self, user: String, password: String) pub fn log_in<'a>(&'a self, user: String, password: String)
-> impl Future<Item = (), Error = Error> + 'a { -> impl Future<Item = (), Error = Error> + 'a {
let request = login::Request { let request = login::Request {