Struct MessageEnvelope

pub struct MessageEnvelope { /* private fields */ }

An envelope that carries a message destined to a remote actor. The envelope contains a serialized message along with its destination and sender.

Implementations

impl MessageEnvelope

pub fn new( sender: ActorId, dest: PortId, data: Serialized, headers: Attrs, ) -> Self

Create a new envelope with the provided sender, destination, and message.

pub fn serialize<T: Serialize + Named>( source: ActorId, dest: PortId, value: &T, headers: Attrs, ) -> Result<Self, Error>

Construct a new serialized value by serializing the provided T-typed value.

pub fn ttl(&self) -> u8

Returns the remaining time-to-live (TTL) for this message.

The TTL is decremented at each MailboxSender hop. When it reaches 0, the message is considered expired and is returned to the sender as undeliverable.

pub fn set_ttl(self, ttl: u8) -> Self

Overrides the message’s time-to-live (TTL).

This replaces the current TTL value (normally initialized from config::MESSAGE_TTL_DEFAULT) with the provided ttl. The updated envelope is returned for chaining.

Note

The TTL is decremented at each MailboxSender hop, and when it reaches 0 the message will be treated as undeliverable.

pub fn deserialized<T: DeserializeOwned + Named>(&self) -> Result<T, Error>

Deserialize the message in the envelope to the provided type T.

pub fn data(&self) -> &Serialized

The serialized message.

pub fn sender(&self) -> &ActorId

The message sender.

pub fn dest(&self) -> &PortId

The destination of the message.

pub fn headers(&self) -> &Attrs

The message headers.

pub fn is_signal(&self) -> bool

Tells whether this is a signal message.

pub fn set_error(&mut self, error: DeliveryError)

Set a delivery error for the message. If errors are already set, append it to the existing errors.

pub fn update_sender(&mut self, sender: ActorId)

Change the sender on the envelope in case it was set incorrectly. This should only be used by CommActor since it is forwarding from another sender.

pub fn set_return_undeliverable(&mut self, return_undeliverable: bool)

Set to true if you want this message to be returned to sender if it cannot reach dest. This is the default. Set to false if you want the message to be dropped instead.

pub fn undeliverable( self, error: DeliveryError, return_handle: PortHandle<Undeliverable<MessageEnvelope>>, )

The message has been determined to be undeliverable with the provided error. Mark the envelope with the error and return to sender.

pub fn errors(&self) -> &Vec<DeliveryError>

Get the errors of why this message was undeliverable. Empty means this message was not determined as undeliverable.

pub fn error_msg(&self) -> Option<String>

Get the string representation of the errors of this message was undeliverable. None means this message was not determined as undeliverable.

Trait Implementations

impl Clone for MessageEnvelope

fn clone(&self) -> MessageEnvelope

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MessageEnvelope

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MessageEnvelope

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for MessageEnvelope

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

Formats the value using the given formatter.

impl Named for MessageEnvelope

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 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

The globally unique port for this type. Typed ports are in the range of 1<<63..1<<64-1.

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

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

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 Serialize for MessageEnvelope

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

where __S: Serializer,

Serialize this value into the given Serde serializer.