Struct JoinBuilder 

pub struct JoinBuilder<'a, Provider: OpenMlsProvider> { /* private fields */ }

Available on 32-bit or 64-bit only.

Builder for joining a group.

Create this with StagedWelcome::build_from_welcome.

Implementations

impl<'a, Provider: OpenMlsProvider> JoinBuilder<'a, Provider>

pub fn new(provider: &'a Provider, processed_welcome: ProcessedWelcome) -> Self

Create a new builder for the JoinBuilder.

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

When joining a subgroup branch or a reinitialized group, controls whether Self::build checks the new group’s members by credential equality. Defaults to true. Note: This is a shortcut for members that are identical if and only if credentials are identical. For more complex member equivalence conditions, the application must disable this and perform the equivalence check itself.

For a subgroup branch, every subgroup member must also be a member of the parent group (receiver check (c)). For a reinit, the new group’s member credentials must be identical to the old group’s.

This has no effect on a regular (non-branch, non-reinit) join.

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

The ratchet tree to use for the new group.

pub fn replace_old_group(self) -> Self

Instruct the builder to replace any existing group with the same ID.

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 processed_welcome(&self) -> &ProcessedWelcome

Get a reference to the ProcessedWelcome.

Use this to inspect the Welcome message before validation.

pub fn build( self, ) -> Result<StagedWelcome, WelcomeError<Provider::StorageError>>

Build the StagedWelcome.