Struct matrix_sdk_crypto::olm::ReadOnlyAccount

pub struct ReadOnlyAccount { /* fields omitted */ }

Account holding identity keys for which sessions can be created.

An account is the central identity for encrypted communication between two devices.

Implementations

impl ReadOnlyAccount

pub fn new(user_id: &UserId, device_id: &DeviceId) -> Self

Create a fresh new account, this will generate the identity key-pair.

pub fn user_id(&self) -> &UserId

Get the user id of the owner of the account.

pub fn device_id(&self) -> &DeviceId

Get the device id that owns this account.

pub fn identity_keys(&self) -> &IdentityKeys

Get the public parts of the identity keys for the account.

pub fn uploaded_key_count(&self) -> u64

Get the currently known uploaded key count.

pub fn shared(&self) -> bool

Has the account been shared with the server.

pub async fn sign(&self, string: &str) -> String

Sign the given string using the accounts signing key.

Returns the signature as a base64 encoded string.

pub async fn pickle(&self, pickle_mode: PicklingMode) -> PickledAccount

Store the account as a base64 encoded string.

Arguments

• pickle_mode - The mode that was used to pickle the account, either an unencrypted mode or an encrypted using passphrase.

pub fn from_pickle(
    pickle: PickledAccount,
    pickle_mode: PicklingMode
) -> Result<Self, OlmAccountError>

Restore an account from a previously pickled one.

Arguments

• pickle - The pickled version of the Account.

• pickle_mode - The mode that was used to pickle the account, either an unencrypted mode or an encrypted using passphrase.

pub async fn sign_json(&self, json: Value) -> String

Convert a JSON value to the canonical representation and sign the JSON string.

Arguments

• json - The value that should be converted into a canonical JSON string.

Panic

Panics if the json value can’t be serialized.

Trait Implementations

impl Clone for ReadOnlyAccount

fn clone(&self) -> ReadOnlyAccount

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ReadOnlyAccount

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<ReadOnlyAccount> for ReadOnlyAccount

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.