Enum StatusMessage 

pub enum StatusMessage {
    GetStatus {
        reply: OncePortRef<Option<ActorStatus>>,
        delivery: Option<(Uuid, EndpointId, OncePortRef<DeliveryProgressResponse>)>,
    },
    SubscribeTerminal {
        subscription_id: Uuid,
        subscriber: PortRef<Option<ActorStatus>>,
    },
    UnsubscribeTerminal {
        subscription_id: Uuid,
    },
}

Actor status control-plane message.

Variants

GetStatus

Return the destination actor’s current or tombstoned status.

Fields

reply: OncePortRef<Option<ActorStatus>>

Reply port receiving None for an unknown actor and Some(status) for a known actor.

delivery: Option<(Uuid, EndpointId, OncePortRef<DeliveryProgressResponse>)>

Optional sender session, destination, and reply port for delivery progress.

SubscribeTerminal

Best-effort notification to subscriber when the destination actor reaches a terminal status. An actor that is already terminal or unknown replies immediately.

Status messages are not ordered, so a subscription and its cancellation may arrive in either order. Cancellation wins: a subscription whose StatusMessage::UnsubscribeTerminal has already arrived is never activated. Use a fresh subscription_id for each subscription, and send each message once.

Fields

subscription_id: Uuid

Identifies this subscription.

subscriber: PortRef<Option<ActorStatus>>

Port receiving None for an unknown actor and Some(status) for a known actor. The subscription is removed before notification.

UnsubscribeTerminal

Cancel the terminal-status subscription with subscription_id, even if its StatusMessage::SubscribeTerminal has not arrived yet.

Fields

subscription_id: Uuid

The id used to subscribe.

Trait Implementations

impl Clone for StatusMessage

fn clone(&self) -> StatusMessage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StatusMessage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StatusMessage

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Named for StatusMessage

fn typename() -> &'static str

The globally unique type name for the type. This should typically be the fully qualified Rust name of the type.

fn typehash() -> u64

A globally unique hash for this type. TODO: actually enforce perfect hashing

fn arm(&self) -> Option<&'static str>

If the named type is an enum, this returns the name of the arm of the value self.

fn typeid() -> TypeId

The TypeId for this type. TypeIds are unique only within a binary, and should not be used for global identification.

fn port() -> u64

A globally unique numeric identifier for this type.

unsafe fn arm_unchecked(self_: *const ()) -> Option<&'static str>

An unsafe version of ‘arm’, accepting a pointer to the value, for use in type-erased settings.

impl PartialEq for StatusMessage

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for StatusMessage