Struct CommitBuilder

pub struct CommitBuilder<'a, C>
where
    C: ClientConfig + Clone,
{ /* private fields */ }

Build a commit with multiple proposals by-value.

Proposals within a commit can be by-value or by-reference. Proposals received during the current epoch will be added to the resulting commit by-reference automatically so long as they pass the rules defined in the current proposal rules.

Implementations

impl<'a, C> CommitBuilder<'a, C>

where C: ClientConfig + Clone,

pub fn add_member( self, key_package: MlsMessage, ) -> Result<CommitBuilder<'a, C>, MlsError>

Insert an AddProposal into the current commit that is being built.

pub fn set_group_info_ext(self, extensions: ExtensionList) -> Self

Set group info extensions that will be inserted into the resulting welcome messages for new members.

Group info extensions that are transmitted as part of a welcome message are encrypted along with other private values.

These extensions can be retrieved as part of NewMemberInfo that is returned by joining the group via Client::join_group.

pub fn remove_member(self, index: u32) -> Result<Self, MlsError>

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

pub fn set_group_context_ext( self, extensions: ExtensionList, ) -> Result<Self, MlsError>

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

pub fn add_external_psk(self, psk_id: ExternalPskId) -> Result<Self, MlsError>

Insert a PreSharedKeyProposal with an external PSK into the current commit that is being built.

pub fn add_resumption_psk(self, psk_epoch: u64) -> Result<Self, MlsError>

Insert a PreSharedKeyProposal with a resumption PSK into the current commit that is being built.

pub fn reinit( self, group_id: Option<Vec<u8>>, version: ProtocolVersion, cipher_suite: CipherSuite, extensions: ExtensionList, ) -> Result<Self, MlsError>

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

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

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

pub fn raw_proposal(self, proposal: Proposal) -> Self

Insert a proposal that was previously constructed such as when a proposal is returned from NewEpoch::unused_proposals.

pub fn raw_proposals(self, proposals: Vec<Proposal>) -> Self

Insert proposals that were previously constructed such as when a proposal is returned from NewEpoch::unused_proposals.

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

Add additional authenticated data to the commit.

Warning

The data provided here is always sent unencrypted.

pub fn set_new_signing_identity( self, signer: SignatureSecretKey, signing_identity: SigningIdentity, ) -> Self

Change the committer’s signing identity as part of making this commit. This will only succeed if the IdentityProvider in use by the group considers the credential inside this signing_identity valid and results in the same identity being used.

pub fn set_leaf_node_extensions( self, new_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) -> Result<CommitOutput, MlsError>

Finalize the commit to send.

Errors

This function will return an error if any of the proposals provided are not contextually valid according to the rules defined by the MLS RFC, or if they do not pass the custom rules defined by the current proposal rules.

pub fn build_detached(self) -> Result<(CommitOutput, CommitSecrets), MlsError>

The same function as GroupBuilder::build except the secrets generated for the commit are outputted instead of being cached internally.

A detached commit can be applied using Group::apply_detached_commit.