Struct Group

pub struct Group { /* private fields */ }

An MLS end-to-end encrypted group.

The group is used to send and process incoming messages and to add/remove users.

See mls_rs::Group for details.

Implementations

impl Group

pub fn write_to_storage(&self) -> Result<(), Error>

Write the current state of the group to storage defined by [ClientConfig::group_state_storage]

pub fn export_tree(&self) -> Result<RatchetTree, Error>

Export the current epoch’s ratchet tree in serialized format.

This function is used to provide the current group tree to new members when use_ratchet_tree_extension is set to false in ClientConfig.

pub fn commit(&self) -> Result<CommitOutput, Error>

Perform a commit of received proposals (or an empty commit).

TODO: ensure path_required is always set in MlsRules::commit_options.

Returns the resulting commit message. See mls_rs::Group::commit for details.

pub fn add_members( &self, key_packages: Vec<Arc<Message>>, ) -> Result<CommitOutput, Error>

Commit the addition of one or more members.

The members are representated by key packages. The result is the welcome messages to send to the new members.

See mls_rs::group::CommitBuilder::add_member for details.

pub fn propose_add_members( &self, key_packages: Vec<Arc<Message>>, ) -> Result<Vec<Arc<Message>>, Error>

Propose to add one or more members to this group.

The members are representated by key packages. The result is the proposal messages to send to the group.

See mls_rs::Group::propose_add for details.

pub fn remove_members( &self, signing_identities: &[Arc<SigningIdentity>], ) -> Result<CommitOutput, Error>

Propose and commit the removal of one or more members.

The members are representated by their signing identities.

See mls_rs::group::CommitBuilder::remove_member for details.

pub fn propose_remove_members( &self, signing_identities: &[Arc<SigningIdentity>], ) -> Result<Vec<Arc<Message>>, Error>

Propose to remove one or more members from this group.

The members are representated by their signing identities. The result is the proposal messages to send to the group.

See mls_rs::group::Group::propose_remove for details.

pub fn encrypt_application_message( &self, message: &[u8], ) -> Result<Message, Error>

Encrypt an application message using the current group state.

pub fn process_incoming_message( &self, message: Arc<Message>, ) -> Result<ReceivedMessage, Error>

Process an inbound message for this group.

Trait Implementations

impl Clone for Group

fn clone(&self) -> Group

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> LiftRef<T> for Group

type LiftType = Arc<Group>

impl<T> LowerReturn<T> for Group

const TYPE_ID_META: MetadataBuffer

type ReturnType = <Group as FfiConverterArc<UniFfiTag>>::FfiType

The type that should be returned by scaffolding functions for this type.

fn lower_return(obj: Self) -> Result<Self::ReturnType, RustBuffer>

Lower this value for scaffolding function return

fn handle_failed_lift(arg_name: &str, e: Error) -> Self

If possible, get a serialized error for failed argument lifts