Struct mls_rs::mls_rules::ProposalInfo

#[non_exhaustive]
pub struct ProposalInfo<T> {
    pub proposal: T,
    pub sender: Sender,
    pub source: ProposalSource,
}

Proposal description used as input to a MlsRules.

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.

proposal: T

The underlying proposal value.

sender: Sender

The sender of this proposal.

source: ProposalSource

The source of the proposal.

Implementations

impl ProposalInfo<Proposal>

pub fn new( proposal: Proposal, sender: Sender, can_transmit: bool ) -> ProposalInfo<Proposal>

Create a new ProposalInfo.

The resulting value will be either transmitted with a commit or locally injected into a commit resolution depending on the can_transmit flag.

This function is useful when implementing custom MlsRules.

impl<T> ProposalInfo<T>

pub fn map<U, F>(self, f: F) -> ProposalInfo<U>

where F: FnOnce(T) -> U,

pub fn as_ref(&self) -> ProposalInfo<&T>

pub fn is_by_value(&self) -> bool

pub fn is_by_reference(&self) -> bool

pub fn proposal_ref(&self) -> Option<&ProposalRef>

The ProposalRef of this proposal if its source is ProposalSource::ByReference

Trait Implementations

impl<T: Clone> Clone for ProposalInfo<T>

fn clone(&self) -> ProposalInfo<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for ProposalInfo<T>

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

Formats the value using the given formatter.

impl<T: PartialEq> PartialEq for ProposalInfo<T>

fn eq(&self, other: &ProposalInfo<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> StructuralPartialEq for ProposalInfo<T>