Enum kinode_process_lib::Message

pub enum Message {
    Request {
        source: Address,
        expects_response: Option<u64>,
        body: Vec<u8>,
        metadata: Option<String>,
        capabilities: Vec<Capability>,
    },
    Response {
        source: Address,
        body: Vec<u8>,
        metadata: Option<String>,
        context: Option<Vec<u8>>,
        capabilities: Vec<Capability>,
    },
}

The basic message type. A message is either a request or a response. Best practice when handling a message is to do this:

1. Match on whether it’s a request or a response
2. Match on who the message is from (the source)
3. Parse and interpret the body, metadata, and/or context based on who the message is from and what your process expects from them.

Variants

Request

Fields

source: Address

expects_response: Option<u64>

body: Vec<u8>

metadata: Option<String>

capabilities: Vec<Capability>

Response

Fields

source: Address

body: Vec<u8>

metadata: Option<String>

context: Option<Vec<u8>>

capabilities: Vec<Capability>

Implementations

impl Message

pub fn source(&self) -> &Address

Get the source of a message.

pub fn body(&self) -> &[u8]

Get the IPC body of a message.

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

Get the metadata of a message.

pub fn context(&self) -> Option<&[u8]>

Get the context of a message. Always None for requests.

pub fn blob(&self) -> Option<LazyLoadBlob>

Get the blob of a message, if any. This function must be called by the process that received the message before receiving another message! The blob can only be consumed immediately after receiving a message.

pub fn capabilities(&self) -> &Vec<Capability>

Get the capabilities of a message.

pub fn is_request(&self) -> bool

Check if a message is a request. Returns false if it’s a response.

pub fn is_local(&self, our: &Address) -> bool

Check if a message was sent by a local process. Returns false if the source node is not our local node.

pub fn is_process<T>(&self, process: T) -> bool

where ProcessId: PartialEq<T>,

Check the ProcessId of a message source against a given ProcessId or something that can be checked for equality against a ProcessId.

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<'de> Deserialize<'de> for Message

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Message

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

where __S: Serializer,

Serialize this value into the given Serde serializer.