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

crypto: Small doc improvements to the OlmMachine.

master
Damir Jelić 2020-08-12 13:11:51 +02:00
parent d706140a8f
commit ccda5c7260
1 changed files with 9 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
matrix_sdk_crypto/src/machine.rs
View File

@ -272,12 +272,14 @@ impl OlmMachine {
/// This should be called every time a group session needs to be shared. /// This should be called every time a group session needs to be shared.
/// ///
/// The response of a successful key claiming requests needs to be passed to /// The response of a successful key claiming requests needs to be passed to
/// the `OlmMachine` with the `receive_keys_claim_response()`. /// the `OlmMachine` with the [`receive_keys_claim_response`].
/// ///
/// # Arguments /// # Arguments
/// ///
/// `users` - The list of users that we should check if we lack a session /// `users` - The list of users that we should check if we lack a session
/// with one of their devices. /// with one of their devices.
///
/// [`receive_keys_claim_response`]: #method.receive_keys_claim_response
pub async fn get_missing_sessions( pub async fn get_missing_sessions(
&self, &self,
users: impl Iterator<Item = &UserId>, users: impl Iterator<Item = &UserId>,
@ -470,6 +472,12 @@ impl OlmMachine {
/// Get a tuple of device and one-time keys that need to be uploaded. /// Get a tuple of device and one-time keys that need to be uploaded.
/// ///
/// Returns an empty error if no keys need to be uploaded. /// Returns an empty error if no keys need to be uploaded.
///
/// The response of a successful key upload requests needs to be passed to
/// the [`OlmMachine`] with the [`receive_keys_upload_response`].
///
/// [`receive_keys_upload_response`]: #method.receive_keys_upload_response
/// [`OlmMachine`]: struct.OlmMachine.html
pub async fn keys_for_upload( pub async fn keys_for_upload(
&self, &self,
) -> StdResult<(Option<DeviceKeys>, Option<OneTimeKeys>), ()> { ) -> StdResult<(Option<DeviceKeys>, Option<OneTimeKeys>), ()> {