Struct ockam::OckamMessage

#[non_exhaustive]
pub struct OckamMessage {
    pub data: Vec<u8>,
    pub scope: Vec<Vec<u8>>,
    pub generic: Option<Metadata>,
}

A message metadata wrapper type

This message wraps around a well-typed Message type, with additional metadata. Metadata is split between the “scope” and “generic” sections.

Scope metadata

This metadata is passed around in a particular metadata scope. For example, a worker that adds some behaviour to message sending may chose to embed “scope” metadata. When wrapping this message in another scope the previously scoped metadata becomes part of the opaque data section.

Thus it is not possible to retrieve metadata from a different nested scope!

Generic metadata

When creating an OckamMessage it’s also possible to attach generic metadata. This data is passed around for every nested scope and must be re-attached to the outest-most scope when peeling a nested message stack.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

data: Vec<u8>

Main data section of this message

scope: Vec<Vec<u8>>

Metadata for this specific scope

generic: Option<Metadata>

Metadata that is carried to the final recipient of the message

Implementations

impl OckamMessage

pub fn new<M: Message>(msg: M) -> Result<Self>

Create a new OckamMessage with the data from msg.

pub fn from_any(msg: Routed<Any>) -> Result<Self>

Create a new OckamMessage from an untyped Any message

pub fn wrap(prev: Self) -> Result<Self>

Create a new OckamMessage by nesting a previous one

pub fn into_routed(
    self,
    msg_addr: Address,
    onward_route: Route,
    return_route: Route
) -> Result<Routed<Self>>

Wrap this OckamMessage with a new Routed message type

pub fn scope_data(self, meta: Vec<u8>) -> Self

Add some metadata to this scope

pub fn generic_data<S: Into<String>>(self, key: S, val: Vec<u8>) -> Self

Add to the generic metadata section

pub fn peel(self) -> Result<Self>

Dissolve this outer layer of Message and reveal nested message

Will throw a deserialisation error if the inner data is NOT an OckamMessage!

pub fn data<M: Message>(&self) -> Result<M>

Decode the data section of this OckamMessage

Trait Implementations

impl Clone for OckamMessage

fn clone(&self) -> OckamMessage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'de> Deserialize<'de> for OckamMessage

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

Deserialize this value from the given Serde deserializer.

impl Serialize for OckamMessage

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

Serialize this value into the given Serde serializer.

impl Message for OckamMessage