Struct arrows::Msg

pub struct Msg { /* private fields */ }

The actual payload received by actors inside a Mail enum construct

Implementations

impl Msg

pub fn new(content: Option<Vec<u8>>, from: &str, to: &str) -> Self

Construct a new message with binary content with from and to addresses

pub fn with_binary_content(content: Option<Vec<u8>>) -> Self

Update the message with binary content

pub fn from_text(content: &str) -> Self

Create a msg with content as text to an actor(actor1) in the local system

Example

use arrows::send;
use arrows::Msg;

let m = Msg::with_text("A good will message");
send!("actor1", m);

pub fn with_text(content: &str, from: &str, to: &str) -> Self

Construct a text message with from and to addresses

pub fn as_text(&self) -> Option<&str>

Get the content of msg as text. In case - binary content being actually binary this would not be helpful.

pub fn is_command(&self) -> bool

Is the message actually a command?

pub fn command_equals(&self, action: Action) -> bool

Command action equality check

pub fn action(&self) -> Option<Action>

Get the embedded Action out if this Msg content is really is Command

pub fn as_bytes(&self) -> Vec<u8>

The message as bytes - irrespective of whether content is text or actual binary blob. Empty byte vec - if can not be serialized

pub fn text_reply(&mut self, reply: &str)

Construct a text reply with content as string and message direction reversed

pub fn update_text_content(&mut self, reply: &str)

Update the content of the message - text

pub fn with_content_and_to(&mut self, new_content: Vec<u8>, new_to: &str)

Set new binary content and new local recipient actor address

pub fn with_content(&mut self, new_content: Vec<u8>)

Set the binary content of the message

pub fn set_recipient_addr(&mut self, addr: &Addr)

Set the recipient address of the message

pub fn set_recipient(&mut self, new_to: &str)

Set the recipient identifier as string literal

pub fn set_recipient_ip(&mut self, new_to_ip: &str)

Set the recipient actor’s IP - used in remoting

pub fn set_recipient_port(&mut self, new_port: u16)

Set the recipient port

pub fn get_recipient_port(&self) -> u16

Get the port of the recipient actor - used for remote messaging

pub fn binary_reply(&mut self, reply: Option<Vec<u8>>)

Reverse the message direction - ‘to’ to ‘from’ or other way

pub fn binary_content(&self) -> Option<Vec<u8>>

Get the binary content - the message remains intact

pub fn binary_content_out(&mut self) -> Option<Vec<u8>>

If the message content is binary blob - get it Would take content out - leaving message content to a None

pub fn get_to(&self) -> &Option<Addr>

Get the address of the actor the message is directed at

pub fn get_id(&self) -> &u64

Get the id

pub fn id_as_string(&self) -> String

Get the id as string. Required because unique ids overflow i64 range supported by the backing store

pub fn get_to_id(&self) -> u64

Get the unique id of the actor message is directed at

pub fn get_from(&self) -> &Option<Addr>

Get the from address

pub fn inbound(&self) -> bool

Check if message is directed at any actor in the system

pub fn set_from(&mut self, from: &Addr)

Set the from address of a message - specific usage while sending out actor message processing outcome

pub fn shutdown() -> Self

Construct a Shutdown command to shutdown the system listener

pub fn echo(s: &str) -> Self

Construct a Echo command to send to the system listener to check its liveness

Trait Implementations

impl Clone for Msg

fn clone(&self) -> Msg

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Msg

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

Formats the value using the given formatter.

impl Default for Msg

fn default() -> Msg

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Msg

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for Msg

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

Formats the value using the given formatter.

impl From<Msg> for Mail

fn from(msg: Msg) -> Self

Performs the conversion.

impl PartialEq<Msg> for Msg

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Serialize for Msg

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 Msg