From 5d46b35d95a4e4255d6c1f2f8684ca7f0bd7bfa6 Mon Sep 17 00:00:00 2001 From: Andy Balaam Date: Fri, 4 Oct 2024 13:49:41 +0100 Subject: [PATCH] crypto: Rename some straggling 'Identities' to 'Identity' The main enum was renamed to `UserIdentity` and some aliases and comments had not kept up. --- bindings/matrix-sdk-crypto-ffi/src/users.rs | 2 +- .../matrix-sdk-crypto/src/identities/user.rs | 2 +- crates/matrix-sdk-crypto/src/machine/mod.rs | 2 +- .../src/encryption/identities/users.rs | 24 +++++++++---------- 4 files changed, 15 insertions(+), 15 deletions(-) diff --git a/bindings/matrix-sdk-crypto-ffi/src/users.rs b/bindings/matrix-sdk-crypto-ffi/src/users.rs index 6120f4c83..dfffd9fe5 100644 --- a/bindings/matrix-sdk-crypto-ffi/src/users.rs +++ b/bindings/matrix-sdk-crypto-ffi/src/users.rs @@ -2,7 +2,7 @@ use matrix_sdk_crypto::{types::CrossSigningKey, UserIdentity as SdkUserIdentity} use crate::CryptoStoreError; -/// Enum representing cross signing identities of our own user or some other +/// Enum representing cross signing identity of our own user or some other /// user. #[derive(uniffi::Enum)] pub enum UserIdentity { diff --git a/crates/matrix-sdk-crypto/src/identities/user.rs b/crates/matrix-sdk-crypto/src/identities/user.rs index 6948516d9..e70c12013 100644 --- a/crates/matrix-sdk-crypto/src/identities/user.rs +++ b/crates/matrix-sdk-crypto/src/identities/user.rs @@ -446,7 +446,7 @@ impl OtherUserIdentity { pub enum UserIdentityData { /// Our own user identity. Own(OwnUserIdentityData), - /// Identities of other users. + /// The identity of another user. Other(OtherUserIdentityData), } diff --git a/crates/matrix-sdk-crypto/src/machine/mod.rs b/crates/matrix-sdk-crypto/src/machine/mod.rs index 763f9ebb4..949ca1e56 100644 --- a/crates/matrix-sdk-crypto/src/machine/mod.rs +++ b/crates/matrix-sdk-crypto/src/machine/mod.rs @@ -2090,7 +2090,7 @@ impl OlmMachine { /// the requests from [`OlmMachine::outgoing_requests`] are being /// processed and sent out. /// - /// Returns a `UserIdentities` enum if one is found and the crypto store + /// Returns a [`UserIdentity`] enum if one is found and the crypto store /// didn't throw an error. #[instrument(skip(self))] pub async fn get_identity( diff --git a/crates/matrix-sdk/src/encryption/identities/users.rs b/crates/matrix-sdk/src/encryption/identities/users.rs index b2f989e46..d71ca1e7e 100644 --- a/crates/matrix-sdk/src/encryption/identities/users.rs +++ b/crates/matrix-sdk/src/encryption/identities/users.rs @@ -15,7 +15,7 @@ use std::collections::BTreeMap; use matrix_sdk_base::{ - crypto::{types::MasterPubkey, CryptoStoreError, UserIdentity as CryptoUserIdentities}, + crypto::{types::MasterPubkey, CryptoStoreError, UserIdentity as CryptoUserIdentity}, RoomMemberships, }; use ruma::{ @@ -100,16 +100,16 @@ impl IdentityUpdates { #[derive(Debug, Clone)] pub struct UserIdentity { client: Client, - inner: CryptoUserIdentities, + inner: CryptoUserIdentity, } impl UserIdentity { - pub(crate) fn new(client: Client, identity: CryptoUserIdentities) -> Self { + pub(crate) fn new(client: Client, identity: CryptoUserIdentity) -> Self { Self { inner: identity, client } } #[cfg(all(feature = "e2e-encryption", not(target_arch = "wasm32")))] - pub(crate) fn underlying_identity(&self) -> CryptoUserIdentities { + pub(crate) fn underlying_identity(&self) -> CryptoUserIdentity { self.inner.clone() } @@ -134,8 +134,8 @@ impl UserIdentity { /// ``` pub fn user_id(&self) -> &UserId { match &self.inner { - CryptoUserIdentities::Own(identity) => identity.user_id(), - CryptoUserIdentities::Other(identity) => identity.user_id(), + CryptoUserIdentity::Own(identity) => identity.user_id(), + CryptoUserIdentity::Other(identity) => identity.user_id(), } } @@ -257,7 +257,7 @@ impl UserIdentity { methods: Option>, ) -> Result { match &self.inner { - CryptoUserIdentities::Own(identity) => { + CryptoUserIdentity::Own(identity) => { let (verification, request) = if let Some(methods) = methods { identity .request_verification_with_methods(methods) @@ -271,7 +271,7 @@ impl UserIdentity { Ok(VerificationRequest { inner: verification, client: self.client.clone() }) } - CryptoUserIdentities::Other(i) => { + CryptoUserIdentity::Other(i) => { let content = i.verification_request_content(methods.clone()); let room = if let Some(room) = self.client.get_dm_room(i.user_id()) { @@ -362,8 +362,8 @@ impl UserIdentity { /// [`Encryption::cross_signing_status()`]: crate::encryption::Encryption::cross_signing_status pub async fn verify(&self) -> Result<(), ManualVerifyError> { let request = match &self.inner { - CryptoUserIdentities::Own(identity) => identity.verify().await?, - CryptoUserIdentities::Other(identity) => identity.verify().await?, + CryptoUserIdentity::Own(identity) => identity.verify().await?, + CryptoUserIdentity::Other(identity) => identity.verify().await?, }; self.client.send(request, None).await?; @@ -465,8 +465,8 @@ impl UserIdentity { /// ``` pub fn master_key(&self) -> &MasterPubkey { match &self.inner { - CryptoUserIdentities::Own(identity) => identity.master_key(), - CryptoUserIdentities::Other(identity) => identity.master_key(), + CryptoUserIdentity::Own(identity) => identity.master_key(), + CryptoUserIdentity::Other(identity) => identity.master_key(), } } }