Enum ProcessResult

Source

pub enum ProcessResult {
    AppMessage(AppMessage),
    Proposal(Proposal),
    Vote(Vote),
    LeaveGroup,
    GetUpdateRequest(GroupUpdateRequest),
    JoinedGroup(String),
    GroupUpdated,
    Noop,
}

Expand description

Result of processing an inbound packet.

This enum represents all possible outcomes from process_inbound. Pass it to dispatch_result to handle consensus routing and get a DispatchAction for your application.

§Variants

AppMessage - A chat message or other application-level message
Proposal / Vote - Consensus messages that need forwarding
GetUpdateRequest - Steward received a membership change request
JoinedGroup - Successfully joined via welcome message
GroupUpdated - MLS state changed (batch commit applied)
LeaveGroup - User was removed from the group
Noop - Nothing to do (message not for us, already processed, etc.)

Variants§

§

AppMessage(AppMessage)

An application message was received (chat message, etc.).

The message has been decrypted and is ready for display.

§

Proposal(Proposal)

A consensus proposal was received from another peer.

Should be forwarded to the consensus service via forward_incoming_proposal.

§

Vote(Vote)

A consensus vote was received from another peer.

Should be forwarded to the consensus service via forward_incoming_vote.

§

LeaveGroup

The user was removed from the group.

Application should clean up group state and notify the UI.

§

GetUpdateRequest(GroupUpdateRequest)

Steward received a membership change request (key package or ban).

Application should start a consensus vote for this request.

§

JoinedGroup(String)

The user successfully joined a group via welcome message.

Contains the group name. Application should transition state from PendingJoin to Working.

§

GroupUpdated

Group MLS state was updated (batch commit applied).

Application should transition state from Waiting to Working.

§

Noop

No action needed.

The message was not for us, was a duplicate, or required no action.

Trait Implementations§

Source §

impl Clone for ProcessResult

Source §

fn clone(&self) -> ProcessResult

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Source §

impl Debug for ProcessResult

Source §

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

Formats the value using the given formatter. Read more

Source §

impl TryFrom<AppMessage> for ProcessResult

Source §

type Error = CoreError

The type returned in the event of a conversion error.

Source §

fn try_from(value: AppMessage) -> Result<Self, Self::Error>

Performs the conversion.

Auto Trait Implementations§

§

impl UnwindSafe for ProcessResult

Blanket Implementations§

Source §

impl<T> Any for T
where T: 'static + ?Sized,

Source §

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

Source §

impl<T> Borrow<T> for T
where T: ?Sized,

Source §

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

Source §

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source §

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

Source §

impl<T> Classify for T

Source §

type Classified = T

Source §

fn classify(self) -> T

Source §

impl<T> CloneToUninit for T
where T: Clone,

Source §

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

Source §

impl<T> Declassify for T

Source §

type Declassified = T

Source §

fn declassify(self) -> T

Source §

impl<T> DynClone for T
where T: Clone,

Source §

fn __clone_box(&self, _: Private) -> *mut ()

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T> Instrument for T

Source §

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Source §

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Source §

impl<T, U> Into for T
where U: From<T>,

Source §

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source §

impl<T> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §