Struct ExternalCommitBuilder

pub struct ExternalCommitBuilder { /* private fields */ }

This is the builder for external commits. It allows you to build an external commit that can be used to join a group externally. Parameters such as optional SelfRemove proposals from other members, the ratchet tree, and the group join configuration can be set in the first builder stage.

The second stage of this builder is a CommitBuilder that can be used to add one or more PreSharedKeyProposals to the external commit and specify LeafNodeParameters.

Implementations

impl ExternalCommitBuilder

pub fn new() -> Self

Creates a new ExternalCommitBuilder with default values.

pub fn with_proposals(self, proposals: Vec<PublicMessageIn>) -> Self

Adds SelfRemove proposals to the external commit. Other proposals or other types of messages are ignored.

pub fn with_ratchet_tree(self, ratchet_tree: RatchetTreeIn) -> Self

Specifies the ratchet tree to use for the external commit. This is only used if the ratchet tree is not provided in the VerifiableGroupInfo extensions. A ratchet tree must be provided, either in the VerifiableGroupInfo extensions or via this method.

pub fn with_config(self, config: MlsGroupJoinConfig) -> Self

Specifies the configuration to use for the group built as part of the external commit. Note that the external commit will always be a PublicMessage regardless of the wire format policy set in the group config.

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

Specifies additional authenticated data (AAD) to be included in the external commit.

pub fn skip_lifetime_validation(self) -> Self

Skip the validation of lifetimes in leaf nodes in the ratchet tree. Note that only the leaf nodes are checked that were never updated.

By default they are validated.

pub fn build_group<Provider: OpenMlsProvider>( self, provider: &Provider, verifiable_group_info: VerifiableGroupInfo, credential_with_key: CredentialWithKey, ) -> Result<CommitBuilder<'_, Initial, MlsGroup>, ExternalCommitBuilderError<Provider::StorageError>>

Build the MlsGroup from the provided VerifiableGroupInfo and CredentialWithKey.

Returns a CommitBuilder that can be used to further configure the external commit.

Trait Implementations

impl Default for ExternalCommitBuilder

fn default() -> ExternalCommitBuilder

Returns the “default value” for a type.