Struct Client

pub struct Client { /* private fields */ }

An MLS client used to create key packages and manage groups.

See mls_rs::Client for details.

Implementations

impl Client

pub fn new( id: Vec<u8>, signature_keypair: SignatureKeypair, client_config: ClientConfig, ) -> Self

Create a new client.

The user is identified by id, which will be used to create a basic credential together with the signature keypair.

See mls_rs::Client::builder for details.

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

Generate a new key package for this client.

The key package is represented in is MLS message form. It is needed when joining a group and can be published to a server so other clients can look it up.

See mls_rs::Client::generate_key_package_message for details.

pub fn signing_identity(&self) -> Result<Arc<SigningIdentity>, Error>

pub fn create_group(&self, group_id: Option<Vec<u8>>) -> Result<Group, Error>

Create and immediately join a new group.

If a group ID is not given, the underlying library will create a unique ID for you.

See mls_rs::Client::create_group and mls_rs::Client::create_group_with_id for details.

pub fn join_group( &self, ratchet_tree: Option<RatchetTree>, welcome_message: &Message, ) -> Result<JoinInfo, Error>

Join an existing group.

You must supply ratchet_tree if the client that created welcome_message did not set use_ratchet_tree_extension.

See mls_rs::Client::join_group for details.

pub fn load_group(&self, group_id: Vec<u8>) -> Result<Group, Error>

Load an existing group.

See mls_rs::Client::load_group for details.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.

impl<T> LiftRef<T> for Client

type LiftType = Arc<Client>

impl<T> LowerReturn<T> for Client

const TYPE_ID_META: MetadataBuffer

type ReturnType = <Client 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