Struct ExternalCommitBuilder

pub struct ExternalCommitBuilder<C: ClientConfig> { /* private fields */ }

A builder that aids with the construction of an external commit.

Implementations

impl<C: ClientConfig> ExternalCommitBuilder<C>

pub fn with_tree_data(self, tree_data: ExportedTree<'static>) -> Self

Use external tree data if the GroupInfo message does not contain a RatchetTreeExt

pub fn with_removal(self, to_remove: u32) -> Self

Propose the removal of an old version of the client as part of the external commit. Only one such proposal is allowed.

pub fn with_authenticated_data(self, data: Vec<u8>) -> Self

Add plaintext authenticated data to the resulting commit message.

pub fn with_external_psk(self, psk: ExternalPskId) -> Self

Add an external psk to the group as part of the external commit.

pub fn with_custom_proposal(self, proposal: CustomProposal) -> Self

Insert a CustomProposal into the current commit that is being built.

pub fn with_received_custom_proposal(self, proposal: MlsMessage) -> Self

Insert a CustomProposal received from a current group member into the current commit that is being built.

Warning

The authenticity of the proposal is NOT fully verified. It is only verified the same way as by ExternalGroup. The proposal MUST be an MlsPlaintext, else the Self::build function will fail.

pub fn with_leaf_node_extensions( self, leaf_node_extensions: ExtensionList, ) -> Self

Change the committer’s leaf node extensions as part of making this commit.

pub fn commit_time(self, commit_time: MlsTime) -> Self

Add a time to associate with the commit creation.

pub fn build( self, group_info: MlsMessage, ) -> Result<(Group<C>, MlsMessage), MlsError>

Build the external commit using a GroupInfo message provided by an existing group member.