Struct ProposalBundle

pub struct ProposalBundle { /* private fields */ }

A collection of proposals.

Implementations

impl ProposalBundle

pub fn add( &mut self, proposal: Proposal, sender: Sender, source: ProposalSource, )

pub fn remove<T: Proposable>(&mut self, index: usize)

Remove the proposal of type T at index

Type T can be any of the standard MLS proposal types defined in the proposal module.

index is consistent with the index returned by any of the proposal type specific functions in this module.

pub fn by_type<'a, T: Proposable + 'a>( &'a self, ) -> impl Iterator<Item = &'a ProposalInfo<T>>

Iterate over proposals, filtered by type.

Type T can be any of the standard MLS proposal types defined in the proposal module.

pub fn retain_by_type<T, F, E>(&mut self, f: F) -> Result<(), E>

where T: Proposable, F: FnMut(&ProposalInfo<T>) -> Result<bool, E>,

Retain proposals, filtered by type.

Type T can be any of the standard MLS proposal types defined in the proposal module.

pub fn retain_custom<F, E>(&mut self, f: F) -> Result<(), E>

where F: FnMut(&ProposalInfo<CustomProposal>) -> Result<bool, E>,

Retain custom proposals in the bundle.

pub fn retain<F, E>(&mut self, f: F) -> Result<(), E>

where F: FnMut(&ProposalInfo<BorrowedProposal<'_>>) -> Result<bool, E>,

Retain MLS standard proposals in the bundle.

pub fn length(&self) -> usize

The number of proposals in the bundle

pub fn iter_proposals( &self, ) -> impl Iterator<Item = ProposalInfo<BorrowedProposal<'_>>>

Iterate over all proposals inside the bundle.

pub fn into_proposals(self) -> impl Iterator<Item = ProposalInfo<Proposal>>

Iterate over proposal in the bundle, consuming the bundle.

pub fn add_proposals(&self) -> &[ProposalInfo<AddProposal>]

Add proposals in the bundle.

pub fn update_proposals(&self) -> &[ProposalInfo<UpdateProposal>]

Update proposals in the bundle.

pub fn update_proposal_senders(&self) -> &[LeafIndex]

Senders of update proposals in the bundle.

pub fn remove_proposals(&self) -> &[ProposalInfo<RemoveProposal>]

Remove proposals in the bundle.

pub fn psk_proposals(&self) -> &[ProposalInfo<PreSharedKeyProposal>]

Pre-shared key proposals in the bundle.

pub fn reinit_proposals(&self) -> &[ProposalInfo<ReInitProposal>]

Reinit proposals in the bundle.

pub fn external_init_proposals(&self) -> &[ProposalInfo<ExternalInit>]

External init proposals in the bundle.

pub fn group_context_ext_proposals(&self) -> &[ProposalInfo<ExtensionList>]

Group context extension proposals in the bundle.

pub fn custom_proposals(&self) -> &[ProposalInfo<CustomProposal>]

Custom proposals in the bundle.

pub fn custom_proposal_types(&self) -> impl Iterator<Item = ProposalType> + '_

Custom proposal types that are in use within this bundle.

pub fn proposal_types(&self) -> impl Iterator<Item = ProposalType> + '_

Standard proposal types that are in use within this bundle.

Trait Implementations

impl Clone for ProposalBundle

fn clone(&self) -> ProposalBundle

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProposalBundle

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

Formats the value using the given formatter.

impl Default for ProposalBundle

fn default() -> ProposalBundle

Returns the “default value” for a type.

impl<'a> FromIterator<&'a (ProposalRef, CachedProposal)> for ProposalBundle

fn from_iter<I>(iter: I) -> Self

where I: IntoIterator<Item = &'a (ProposalRef, CachedProposal)>,

Creates a value from an iterator.

impl<'a> FromIterator<(&'a ProposalRef, &'a CachedProposal)> for ProposalBundle

fn from_iter<I>(iter: I) -> Self

where I: IntoIterator<Item = (&'a ProposalRef, &'a CachedProposal)>,

Creates a value from an iterator.

impl FromIterator<(Proposal, Sender, ProposalSource)> for ProposalBundle

fn from_iter<I>(iter: I) -> Self

where I: IntoIterator<Item = (Proposal, Sender, ProposalSource)>,

Creates a value from an iterator.