Struct service_io::message::Message

pub struct Message {
    pub user: String,
    pub service_name: String,
    pub args: Vec<String>,
    pub body: String,
    pub attached_data: HashMap<String, Vec<u8>>,
}

Common data shared among input/output/services. This is the language service-io talk. Each input/output/service understand this structure.

Example

use service_io::message::Message;

let request = Message::default()
    .user("user_01")
    .service_name("my_service")
    .args(["arg0", "arg1", "arg2", "this is arg3"])
    .body("body of the message")
    .attach([
        ("file1.txt", b"content data".to_vec()),
        ("file2.txt", b"1234".to_vec())
    ]);

Fields

user: String

The user this message is related to. If the message is in the input side, this user means the originator of the message. If the message is in the output side, this user means the recipient of the message.

service_name: String

The service name this message going to/come from. The value of this field should match to any name used for register services.

See also: Engine::add_service()

args: Vec<String>

Arguments of the message. Each service implementation will understand these values in their own way.

body: String

Main body of the message. Each service implementation will understand this value in their own way.

attached_data: HashMap<String, Vec<u8>>

Attached content of the message. Each service implementation will understand these values in their own way.

Implementations

impl Message

pub fn response(message: &Message) -> Message

Sugar to perform a response of a received message. Creates an empty message with same Message::user and Message::service_name as the passed message.

Example

use service_io::message::Message;

let request = Message::default()
    .user("user_01")
    .service_name("my_service")
    .body("1234");

let response = Message::response(&request);

// Name and service_name are copied
assert_eq!(request.user, response.user);
assert_eq!(request.service_name, response.service_name);

// But other fields as body are not copied.
assert_ne!(request.body, response.body);

pub fn user(self, user: impl Into<String>) -> Self

Set a user for the message

pub fn service_name(self, service_name: impl Into<String>) -> Self

Set a service name for the message

pub fn args<S: Into<String>>(self, args: impl IntoIterator<Item = S>) -> Self

Set args for the message

pub fn body(self, body: impl Into<String>) -> Self

Set a body for the message

pub fn attach<S: Into<String>>(
    self,
    attached: impl IntoIterator<Item = (S, Vec<u8>)>
) -> Self

Set attached data for the message

Trait Implementations

impl Clone for Message

fn clone(&self) -> Message

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Message

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

Formats the value using the given formatter.

impl Default for Message

fn default() -> Message

Returns the “default value” for a type.

impl PartialEq<Message> for Message

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Message