Struct mls_rs::group::CommitOutput

#[non_exhaustive]
pub struct CommitOutput {
    pub commit_message: MlsMessage,
    pub welcome_messages: Vec<MlsMessage>,
    pub ratchet_tree: Option<ExportedTree<'static>>,
    pub external_commit_group_info: Option<MlsMessage>,
}

Result of MLS commit operation using Group::commit or CommitBuilder::build.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

commit_message: MlsMessage

Commit message to send to other group members.

welcome_messages: Vec<MlsMessage>

Welcome messages to send to new group members. If the commit does not add members, this list is empty. Otherwise, if MlsRules::commit_options returns single_welcome_message set to true, then this list contains a single message sent to all members. Else, the list contains one message for each added member. Recipients of each message can be identified using MlsMessage::key_package_reference of their key packages and MlsMessage::welcome_key_package_references.

ratchet_tree: Option<ExportedTree<'static>>

Ratchet tree that can be sent out of band if ratchet_tree_extension is not used according to MlsRules::encryption_options.

external_commit_group_info: Option<MlsMessage>

A group info that can be provided to new members in order to enable external commit functionality. This value is set if MlsRules::commit_options returns allow_external_commit set to true.

Trait Implementations

impl Clone for CommitOutput

fn clone(&self) -> CommitOutput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CommitOutput

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

Formats the value using the given formatter.