Struct ockam_core::Routed

pub struct Routed<M: Message> { /* private fields */ }

A message wrapper that provides message route information.

Workers can accept arbitrary message types, which may not contain information about their routes.

However, the Ockam worker and messaging system already keeps track of this information internally.

This type makes it possible to expose this information to the user, without requiring changes to the user’s message types.

Examples

See ockam_node::WorkerRelay for a usage example.

Implementations

impl<M: Message> Routed<M>

pub fn new( inner: M, msg_addr: Address, src_addr: Address, local_msg: LocalMessage ) -> Self

Create a new Routed message wrapper from the given message, message address and a local message that contains routing information.

pub fn msg_addr(&self) -> Address

Return a copy of the message address.

pub fn src_addr(&self) -> Address

True sender of the message

pub fn onward_route(&self) -> Route

Return a copy of the onward route for the wrapped message.

pub fn return_route(&self) -> Route

Return a copy of the full return route for the wrapped message.

pub fn sender(&self) -> Result<Address>

Return a copy of the sender address for the wrapped message.

pub fn body(self) -> M

Consume the message wrapper and return the original message.

pub fn as_body(&self) -> &M

Return a reference to the wrapped message.

pub fn into_local_message(self) -> LocalMessage

Consume the message wrapper and return the underlying local message.

pub fn into_transport_message(self) -> TransportMessage

Consume the message wrapper and return the underlying transport message.

pub fn local_message(&self) -> &LocalMessage

Return a reference to the underlying local message.

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

Return a reference to the underlying transport message’s binary payload.

pub fn take_payload(self) -> Vec<u8>

Consume the message wrapper and return the underlying transport message’s binary payload.

impl Routed<Any>

pub fn cast<M: Message>(self) -> Result<Routed<M>>

Try to cast an Any message into another valid message type

Trait Implementations

impl<M: Message + Debug> Debug for Routed<M>

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

Formats the value using the given formatter.

impl<M: Message> Deref for Routed<M>

type Target = M

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<M: Message> DerefMut for Routed<M>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<M: Message + Display> Display for Routed<M>

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

Formats the value using the given formatter.

impl<M: Message + PartialEq> PartialEq<M> for Routed<M>

fn eq(&self, o: &M) -> 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.