char
/
matrix-rust-sdk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

matrix-sdk: Add links from the login method docs to the restore_login ones.

master
Damir Jelić 2020-10-06 11:40:32 +02:00
parent 137fa9619f
commit 84039ad7aa
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
matrix_sdk/src/client.rs
View File

@ -477,7 +477,7 @@ impl Client {
/// If this isn't the first login a device id should be provided to restore /// If this isn't the first login a device id should be provided to restore
/// the correct stores. /// the correct stores.
/// ///
/// Alternatively the `restore_login()` method can be used to restore a /// Alternatively the [`restore_login`] method can be used to restore a
/// logged in client without the password. /// logged in client without the password.
/// ///
/// # Arguments /// # Arguments
@ -490,6 +490,8 @@ impl Client {
/// not given the homeserver will create one. Can be an existing /// not given the homeserver will create one. Can be an existing
/// device_id from a previous login call. Note that this should be done /// device_id from a previous login call. Note that this should be done
/// only if the client also holds the encryption keys for this device. /// only if the client also holds the encryption keys for this device.
///
/// [`restore_login`]: #method.restore_login
#[instrument(skip(password))] #[instrument(skip(password))]
pub async fn login( pub async fn login(
&self, &self,
@ -521,13 +523,15 @@ impl Client {
/// This can be used to restore the client to a logged in state, loading all /// This can be used to restore the client to a logged in state, loading all
/// the stored state and encryption keys. /// the stored state and encryption keys.
/// ///
/// Alternatively, if the whole session isn't stored the `login()` method /// Alternatively, if the whole session isn't stored the [`login`] method
/// can be used with a device id. /// can be used with a device id.
/// ///
/// # Arguments /// # Arguments
/// ///
/// * `session` - A session that the user already has from a /// * `session` - A session that the user already has from a
/// previous login call. /// previous login call.
///
/// [`login`]: #method.login
pub async fn restore_login(&self, session: Session) -> Result<()> { pub async fn restore_login(&self, session: Session) -> Result<()> {
Ok(self.base_client.restore_login(session).await?) Ok(self.base_client.restore_login(session).await?)
} }