Struct ockam_core::Routed

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

A message wrapper that stores message route information

Workers can accept arbitrary message types, which may not contain information about their routes. However, the ockam worker & messaging system already keeps track of this information internally. This type exposes this information to the user, without requiring changes in the user message types.

Implementations

impl<M: Message> Routed<M>

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

Create a new Routed message wrapper

pub fn msg_addr(&self) -> Address

Return a copy of the message address

pub fn onward_route(&self) -> Route

Return a copy of the onward route for this message

pub fn return_route(&self) -> Route

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

pub fn sender(&self) -> Address

Get a copy of the message sender address

pub fn body(self) -> M

Consume the message wrapper

pub fn as_body(&self) -> &M

Borrow the inner body

pub fn into_local_message(self) -> LocalMessage

Consume the message wrapper to the underlying local message

pub fn into_transport_message(self) -> TransportMessage

Consume the message wrapper to the underlying transport message

pub fn local_message(&self) -> &LocalMessage

Consume the message wrapper to the underlying local message

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

Get a reference to the underlying binary message payload

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 !=.