Enum quickwit_actors::ActorExitStatus

pub enum ActorExitStatus {
    Success,
    Quit,
    DownstreamClosed,
    Killed,
    Failure(Arc<Error>),
    Panicked,
}

The actor exit status represents the outcome of the execution of an actor, after the end of the execution.

It is in many ways, similar to the exit status code of a program.

Variants

Success

The actor successfully exited.

It happens either because:

• all of the existing mailboxes were dropped and the actor message queue was exhausted. No new message could ever arrive to the actor. (This exit is triggered by the framework.) or
• the actor process_message method returned Err(ExitStatusCode::Success). (This exit is triggered by the actor implementer.)

(This is equivalent to exit status code 0.) Note that this is not really an error.

Quit

The actor was asked to gracefully shutdown.

(Semantically equivalent to exit status code 130, triggered by SIGINT aka Ctrl-C, or SIGQUIT)

DownstreamClosed

The actor tried to send a message to a dowstream actor and failed. The logic ruled that the actor should be killed.

(Semantically equivalent to exit status code 141, triggered by SIGPIPE)

Killed

The actor was killed.

It can happen because:

• it received Command::Kill.
• its kill switch was activated.

(Semantically equivalent to exit status code 137, triggered by SIGKILL)

Failure(Arc<Error>)

An unexpected error happened while processing a message.

Panicked

The thread or the task executing the actor loop panicked.

Implementations

impl ActorExitStatus

pub fn is_success(&self) -> bool

Trait Implementations

impl Clone for ActorExitStatus

fn clone(&self) -> ActorExitStatus

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ActorExitStatus

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

Formats the value using the given formatter.

impl Display for ActorExitStatus

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

Formats the value using the given formatter.

impl Error for ActorExitStatus

fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any.

fn backtrace(&self) -> Option<&Backtrace>

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

Returns a stack backtrace, if available, of where this error occurred.

fn description(&self) -> &str

👎 Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎 Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

impl From<Error> for ActorExitStatus

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<SendError> for ActorExitStatus

fn from(_: SendError) -> Self

Converts to this type from the input type.