Struct CommitMessageBundle

pub struct CommitMessageBundle { /* private fields */ }

Contains the messages that are produced by committing. The messages can be accessed individually using getters or through the IntoIterator interface.

Implementations

impl CommitMessageBundle

pub fn commit(&self) -> &MlsMessageOut

Gets a the Commit messsage. For owned version, see Self::into_commit.

pub fn welcome(&self) -> Option<&Welcome>

Gets a the Welcome messsage. Only Some if new clients have been added in the commit. For owned version, see Self::into_welcome.

pub fn to_welcome_msg(&self) -> Option<MlsMessageOut>

Gets a the Welcome messsage. Only Some if new clients have been added in the commit. Performs a copy of the Welcome. For owned version, see Self::into_welcome_msg.

pub fn group_info(&self) -> Option<&GroupInfo>

Gets a the GroupInfo message. Only Some if new clients have been added or the group configuration has use_ratchet_tree_extension set. For owned version, see Self::into_group_info.

pub fn contents(&self) -> (&MlsMessageOut, Option<&Welcome>, Option<&GroupInfo>)

Gets all three messages, some of which optional. For owned version, see Self::into_contents.

pub fn into_commit(self) -> MlsMessageOut

Gets a the Commit messsage. This method consumes the CommitMessageBundle. For a borrowed version see Self::commit.

pub fn into_welcome(self) -> Option<Welcome>

Gets a the Welcome messsage. Only Some if new clients have been added in the commit. This method consumes the CommitMessageBundle. For a borrowed version see Self::welcome.

pub fn into_welcome_msg(self) -> Option<MlsMessageOut>

Gets a the Welcome messsage. Only Some if new clients have been added in the commit. For a borrowed version, see Self::to_welcome_msg.

pub fn into_group_info(self) -> Option<GroupInfo>

Gets a the GroupInfo message. Only Some if new clients have been added or the group configuration has use_ratchet_tree_extension set. This method consumes the CommitMessageBundle. For a borrowed version see Self::group_info.

pub fn into_group_info_msg(self) -> Option<MlsMessageOut>

Gets a the GroupInfo messsage. Only Some if new clients have been added in the commit.

pub fn into_contents( self, ) -> (MlsMessageOut, Option<Welcome>, Option<GroupInfo>)

Gets all three messages, some of which optional. This method consumes the CommitMessageBundle. For a borrowed version see Self::contents.

pub fn into_messages( self, ) -> (MlsMessageOut, Option<MlsMessageOut>, Option<MlsMessageOut>)

Gets all three messages, some of which optional, as MlsMessageOut. This method consumes the CommitMessageBundle.

Trait Implementations

impl Clone for CommitMessageBundle

fn clone(&self) -> CommitMessageBundle

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CommitMessageBundle

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

Formats the value using the given formatter.

impl IntoIterator for CommitMessageBundle

type Item = MlsMessageOut

The type of the elements being iterated over.

type IntoIter = Chain<Chain<IntoIter<MlsMessageOut>, IntoIter<MlsMessageOut>>, IntoIter<MlsMessageOut>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.