Struct gcore::MessageHandle

pub struct MessageHandle(/* private fields */);

Message handle.

Gear allows users and programs to interact with other users and programs via messages. Message creation consists of the following parts: message initialization, filling the message with payload (can be gradual), and message sending.

Here are the functions that make up the parts of forming and sending messages:

• msg::send_init initializes the message
• msg::send_push adds a payload to a message
• msg::send_commit sends a message

To identify a message that is being built from parts of a program, you should use MessageHandle obtained via msg::send_init.

Examples

use gcore::msg;

#[no_mangle]
extern "C" fn handle() {
    let msg_handle = msg::send_init().expect("Unable to init");
    msg::send_push(msg_handle, b"Hello,").expect("Unable to push");
    msg::send_push(msg_handle, b" world!").expect("Unable to push");
    msg::send_commit(msg_handle, msg::source(), 0).expect("Unable to send");
}

Trait Implementations

impl Clone for MessageHandle

fn clone(&self) -> MessageHandle

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MessageHandle

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

Formats the value using the given formatter.

impl PartialEq for MessageHandle

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

impl Eq for MessageHandle

impl StructuralEq for MessageHandle

impl StructuralPartialEq for MessageHandle