Struct ockam::Routed

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

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> Routed<M> where
    M: Message, 

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

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

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

Get underlying binary message payload

Trait Implementations

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

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

Formats the value using the given formatter.

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

type Target = M

The resulting type after dereferencing.

pub fn deref(&self) -> &<Routed<M> as Deref>::Target

Dereferences the value.

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

pub fn deref_mut(&mut self) -> &mut <Routed<M> as Deref>::Target

Mutably dereferences the value.

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

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

Formats the value using the given formatter.

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

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