Struct mls_rs::group::mls_rules::DefaultMlsRules

#[non_exhaustive]
pub struct DefaultMlsRules {
    pub commit_options: CommitOptions,
    pub encryption_options: EncryptionOptions,
}

Default MLS rules with pass-through proposal filter and customizable options.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

commit_options: CommitOptions

encryption_options: EncryptionOptions

Implementations

impl DefaultMlsRules

pub fn new() -> Self

Create new MLS rules with default settings: do not enforce path and do put the ratchet tree in the extension.

pub fn with_commit_options(self, commit_options: CommitOptions) -> Self

Set commit options.

pub fn with_encryption_options( self, encryption_options: EncryptionOptions ) -> Self

Set encryption options.

Trait Implementations

impl Clone for DefaultMlsRules

fn clone(&self) -> DefaultMlsRules

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DefaultMlsRules

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

Formats the value using the given formatter.

impl Default for DefaultMlsRules

fn default() -> DefaultMlsRules

Returns the “default value” for a type.

impl MlsRules for DefaultMlsRules

type Error = Infallible

fn filter_proposals( &self, _direction: CommitDirection, _source: CommitSource, _current_roster: &Roster<'_>, _extension_list: &ExtensionList, proposals: ProposalBundle ) -> Result<ProposalBundle, Self::Error>

This is called when preparing or receiving a commit to pre-process the set of committed proposals.

fn commit_options( &self, _: &Roster<'_>, _: &ExtensionList, _: &ProposalBundle ) -> Result<CommitOptions, Self::Error>

This is called when preparing a commit to determine various options: whether to enforce an update path in case it is not mandated by MLS, whether to include the ratchet tree in the welcome message (if the commit adds members) and whether to generate a single welcome message, or one welcome message for each added member.

fn encryption_options( &self, _: &Roster<'_>, _: &ExtensionList ) -> Result<EncryptionOptions, Self::Error>

This is called when sending any packet. For proposals and commits, this determines whether to encrypt them. For any encrypted packet, this determines the padding mode used.