Enum Signal 

#[repr(u8)]
pub enum Signal {
    Stop = 0,
    Terminate = 1,
}

A message which is used to stop/terminate an actor.

Handler<Signal> is implemented for all actors automatically.

Variants

Stop = 0

Stop the actor.

Set the actor’s state to Stopping and trigger the stopping method of the actor. The actor might be able to resume by itself.

Terminate = 1

Terminate the actor.

Set the actor’s state to Stopped and trigger the post_stop method. Any messages still queued in the mailbox behind this signal are dropped without being handled.

Trait Implementations

impl Clone for Signal

fn clone(&self) -> Signal

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Signal

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

Formats the value using the given formatter.

impl Decode for Signal

Available on crate feature ipc only.

fn decode( buf: Bytes, _ctx: Option<&dyn DecodeContext>, ) -> Result<Self, DecodeError>

Decodes the message from the provided buffer.

impl Encode for Signal

Available on crate feature ipc only.

fn encoded_len(&self) -> usize

Returns the number of bytes this message will encode to.

fn encode( &self, buf: &mut BytesMut, _ctx: Option<&dyn EncodeContext>, ) -> Result<(), EncodeError>

Encodes the message into the provided buffer.

fn encode_to_bytes( &self, ctx: Option<&dyn EncodeContext>, ) -> Result<Bytes, EncodeError>

Encodes the message into a freshly allocated Bytes.

impl<A> Handler<Signal> for A

where A: Actor, A::Context: ActorContext<A>,

type Result = ()

The return type of the handler, which must implement MessageResponse.

fn handle( &mut self, msg: Signal, ctx: &mut Self::Context, ) -> impl Future<Output = Self::Result> + Send

Handles a message.

impl Message for Signal

type Result = ()

The type of the response produced when this message is handled.

impl MessageId for Signal

Available on crate feature identifier only.

const ID: u64

impl PartialEq for Signal

fn eq(&self, other: &Signal) -> 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 StableId for Signal

Available on crate feature identifier only.

const TYPE_ID: StableTypeId

impl TryFrom<u8> for Signal

type Error = ()

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Copy for Signal

impl Eq for Signal

impl StructuralPartialEq for Signal