Enum maxim::actors::Status

pub enum Status {
    Done,
    Skip,
    Reset,
    Stop,
}

Status of the message and potentially the actor as a resulting from processing a message with the actor.

Variants

Done

The message was processed and can be removed from the channel. Note that this doesn't necessarily mean that anything was done with the message, just that it can be removed. It is up to the actor to decide what, if anything, to do with the message.

Skip

The message was skipped and should remain in the channel. Once a message is skipped a skip cursor will be created in the actor's message channel which will act as the actual head of the channel until an Status::Reset is returned from an actor's processor. This enables an actor to skip messages while working on a process and then clear the skip cursor and resume normal processing. This functionality is critical for actors that implement a finite state machine.

Reset

Marks the message as processed and clears the skip cursor on the channel. A skip cursor is present when a message has been skipped by an actor returning Status::Skip from a call to the actor's message processor. If no skip cursor is set than this status is semantically the same as Status::Done.

Stop

Returned from an actor when the actor wants the system to stop the actor. When this status is returned the actor's Aid will no longer send any messages and the actor instance itself will be removed from the actors table in the ActorSystem. The user is advised to do any cleanup needed before returning Status::Stop.

Methods

impl Status

pub fn done<T>(state: T) -> (T, Status)

Ergonomic shortcut for writing (state, Status::Done)

pub fn skip<T>(state: T) -> (T, Status)

Ergonomic shortcut for writing (state, Status::Skip)

pub fn reset<T>(state: T) -> (T, Status)

Ergonomic shortcut for writing (state, Status::Reset)

pub fn stop<T>(state: T) -> (T, Status)

Ergonomic shortcut for writing (state, Status::Stop)

Trait Implementations

impl Debug for Status

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Status

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

Deserialize this value from the given Serde deserializer.

impl Eq for Status

impl PartialEq<Status> for Status

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Serialize for Status

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

Serialize this value into the given Serde serializer.

impl StructuralEq for Status

impl StructuralPartialEq for Status