Struct StagedCommit 

pub struct StagedCommit {
    pub staged_proposal_queue: ProposalQueue,
    /* private fields */
}

Contains the changes from a commit to the group state.

Fields

staged_proposal_queue: ProposalQueue

A queue containing the proposals associated with the commit.

Implementations

impl StagedCommit

pub fn add_proposals(&self) -> impl Iterator<Item = QueuedAddProposal<'_>>

Returns the Add proposals that are covered by the Commit message as in iterator over QueuedAddProposal.

pub fn remove_proposals(&self) -> impl Iterator<Item = QueuedRemoveProposal<'_>>

Returns the Remove proposals that are covered by the Commit message as in iterator over QueuedRemoveProposal.

pub fn update_proposals(&self) -> impl Iterator<Item = QueuedUpdateProposal<'_>>

Returns the Update proposals that are covered by the Commit message as in iterator over QueuedUpdateProposal.

pub fn psk_proposals(&self) -> impl Iterator<Item = QueuedPskProposal<'_>>

Returns the PresharedKey proposals that are covered by the Commit message as in iterator over QueuedPskProposal.

pub fn queued_proposals(&self) -> impl Iterator<Item = &QueuedProposal>

Returns an iterator over all QueuedProposals.

pub fn update_path_leaf_node(&self) -> Option<&LeafNode>

Returns the leaf node of the (optional) update path.

pub fn credentials_to_verify(&self) -> impl Iterator<Item = &Credential>

Returns the credentials that the caller needs to verify are valid.

pub fn self_removed(&self) -> bool

Returns true if the member was removed through a proposal covered by this Commit message and false otherwise.

pub fn group_context(&self) -> &GroupContext

Returns the GroupContext of the staged commit state.

pub fn epoch_authenticator(&self) -> Option<&EpochAuthenticator>

Returns the EpochAuthenticator of the staged commit state if the owner of the originating group state is a member of the group. Returns None otherwise.

Trait Implementations

impl Clone for StagedCommit

fn clone(&self) -> StagedCommit

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StagedCommit

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StagedCommit

fn deserialize<__D>( __deserializer: __D, ) -> Result<StagedCommit, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<PendingCommitState> for StagedCommit

fn from(pcs: PendingCommitState) -> StagedCommit

Converts to this type from the input type.

impl PartialEq for StagedCommit

fn eq(&self, other: &StagedCommit) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for StagedCommit

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for StagedCommit