Struct MlsGroupBuilder

pub struct MlsGroupBuilder { /* private fields */ }

Builder struct for an MlsGroup.

Implementations

impl MlsGroupBuilder

pub fn with_group_id(self, group_id: GroupId) -> Self

Sets the group ID of the MlsGroup.

pub fn build<Provider: OpenMlsProvider>( self, provider: &Provider, signer: &impl Signer, credential_with_key: CredentialWithKey, ) -> Result<MlsGroup, NewGroupError<Provider::StorageError>>

Build a new group as configured by this builder.

pub fn with_wire_format_policy( self, wire_format_policy: WireFormatPolicy, ) -> Self

Sets the wire_format property of the MlsGroup.

pub fn padding_size(self, padding_size: usize) -> Self

Sets the padding_size property of the MlsGroup.

pub fn max_past_epochs(self, max_past_epochs: usize) -> Self

Sets the max_past_epochs property of the MlsGroup. This allows application messages from previous epochs to be decrypted.

WARNING

This feature enables the storage of message secrets from past epochs. It is a trade-off between functionality and forward secrecy and should only be enabled if the Delivery Service cannot guarantee that application messages will be sent in the same epoch in which they were generated. The number for max_epochs should be as low as possible.

pub fn number_of_resumption_psks(self, number_of_resumption_psks: usize) -> Self

Sets the number_of_resumption_psks property of the MlsGroup.

pub fn use_ratchet_tree_extension( self, use_ratchet_tree_extension: bool, ) -> Self

Sets the use_ratchet_tree_extension property of the MlsGroup.

pub fn sender_ratchet_configuration( self, sender_ratchet_configuration: SenderRatchetConfiguration, ) -> Self

Sets the sender_ratchet_configuration property of the MlsGroup. See SenderRatchetConfiguration for more information.

pub fn lifetime(self, lifetime: Lifetime) -> Self

Sets the lifetime of the group creator’s leaf.

pub fn ciphersuite(self, ciphersuite: Ciphersuite) -> Self

Sets the ciphersuite of the MlsGroup.

pub fn with_group_context_extensions( self, extensions: Extensions, ) -> Result<Self, InvalidExtensionError>

Sets the initial group context extensions

pub fn with_leaf_node_extensions( self, extensions: Extensions, ) -> Result<Self, LeafNodeValidationError>

Sets the initial leaf node extensions

pub fn with_capabilities(self, capabilities: Capabilities) -> Self

Sets the group creator’s Capabilities

Trait Implementations

impl Debug for MlsGroupBuilder

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

Formats the value using the given formatter.

impl Default for MlsGroupBuilder

fn default() -> MlsGroupBuilder

Returns the “default value” for a type.