Struct ConversationMut 

pub struct ConversationMut { /* private fields */ }

A mutable view of an MLS conversation.

The conversation is ultimately owned by the conversation cache, but we take an Arc here so that we don’t have to tie the lifetime of the guard to the cache.

More generally, the conversation guard gives us convenient mutable accesses to a single conversation. This in turn means that we don’t have to duplicate the entire conversation API on TransactionContext.

Implementations

impl ConversationMut

pub async fn add_members( &mut self, key_packages: Vec<KeyPackageIn>, ) -> Result<()>

Adds new members to the group/conversation

pub async fn remove_members( &mut self, clients: &[impl Borrow<ClientIdRef>], ) -> Result<()>

Removes clients from the group/conversation.

Arguments

• id - group/conversation id
• clients - list of client ids to be removed from the group

pub async fn update_key_material(&mut self) -> Result<()>

Self updates the own leaf node and automatically commits. Pending proposals will be committed.

pub async fn set_credential_by_ref( &mut self, credential_ref: &CredentialRef, ) -> Result<()>

Set the referenced credential for this conversation.

pub async fn commit_pending_proposals(&mut self) -> Result<()>

Commits all pending proposals of the group

impl ConversationMut

pub async fn decrypt_message( &mut self, message: impl AsRef<[u8]>, ) -> Result<DecryptedMessage>

Deserializes a TLS-serialized message, then processes it. Note: this will discard any local pending commits or proposals.

Arguments

• message - the encrypted message as a byte array

Errors

If a message has been buffered, this will be indicated by an error. Other errors are originating from OpenMls and the KeyStore

impl ConversationMut

pub async fn encrypt_message( &mut self, message: impl AsRef<[u8]>, ) -> Result<Vec<u8>>

Encrypts a raw payload then serializes it to the TLS wire format.

Can only be called when there is no pending commit and no pending proposal.

Arguments

• message - the message as a byte array

Return type

This method will return an encrypted TLS serialized message.

Errors

If the conversation can’t be found, an error will be returned. Other errors are originating from OpenMls and the KeyStore

impl ConversationMut

pub async fn enable_history_sharing(&mut self) -> Result<()>

Enable history sharing by generating a history client and adding it to the conversation.

pub async fn disable_history_sharing(&mut self) -> Result<()>

Disable history sharing by removing history clients from the conversation.

impl ConversationMut

pub async fn wipe(&mut self) -> Result<()>

Destroys a group locally

Errors

KeyStore errors, such as IO

impl ConversationMut

pub const fn new( inner: Arc<Conversation>, tx_context: TransactionContext, ) -> ConversationMut

Trait Implementations

impl Debug for ConversationMut

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

Formats the value using the given formatter.

impl Deref for ConversationMut

where Arc<Conversation>: Deref,

type Target = <Arc<Conversation> as Deref>::Target

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.