ExitReason

Enum ExitReason 

Source
pub enum ExitReason {
    Normal,
    Killed,
    Panic(String),
    Shutdown,
    Custom(String),
}
Expand description

Reason for actor termination.

Exit reasons indicate why an actor stopped. They are used to determine whether a supervisor should restart a failed actor.

§Examples

use joerl::ExitReason;

let normal = ExitReason::Normal;
assert!(normal.is_normal());
assert!(normal.is_trappable());

let killed = ExitReason::Killed;
assert!(!killed.is_normal());
assert!(!killed.is_trappable()); // Cannot be trapped

let panic = ExitReason::Panic("something went wrong".to_string());
assert!(!panic.is_normal());
assert_eq!(panic.to_string(), "panic: something went wrong");

Variants§

§

Normal

Normal termination.

§

Killed

Actor was killed explicitly.

§

Panic(String)

Actor panicked with an error message.

§

Shutdown

Actor terminated due to supervisor shutdown.

§

Custom(String)

Custom exit reason.

Implementations§

Source§

impl ExitReason

Source

pub fn is_normal(&self) -> bool

Returns true if this is a normal exit.

Normal exits typically don’t trigger restarts in supervisors.

§Examples
use joerl::ExitReason;

assert!(ExitReason::Normal.is_normal());
assert!(!ExitReason::Killed.is_normal());
assert!(!ExitReason::Panic("error".into()).is_normal());
Source

pub fn is_trappable(&self) -> bool

Returns true if this exit reason can be trapped.

Actors with trap_exit(true) can handle trappable exit signals without terminating. The Killed reason cannot be trapped.

§Examples
use joerl::ExitReason;

assert!(ExitReason::Normal.is_trappable());
assert!(ExitReason::Panic("error".into()).is_trappable());
assert!(!ExitReason::Killed.is_trappable()); // Cannot be trapped

Trait Implementations§

Source§

impl Clone for ExitReason

Source§

fn clone(&self) -> ExitReason

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 ExitReason

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for ExitReason

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for ExitReason

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Eq for ExitReason

Source§

impl StructuralPartialEq for ExitReason

Auto Trait Implementations§

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> 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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
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<U> 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more