Struct ockam_core::LocalMessage

pub struct LocalMessage { /* private fields */ }

A message type that is routed locally within a single node.

LocalMessage contains:

• An onward route for the message
• A return route
• A binary payload
• Additional metadata as LocalInfo in binary format, that can be added by Workers within the same node.

A LocalMessage can be converted from a TransportMessage that has just been deserialized from some binary data arriving on a node.

It can also be converted to a TransportMessage to be serialized and sent to another node.

When a LocalMessage has been processed by a worker, its onward_route and return_route need to be modified before the message is sent to another worker. This is generally done by:

• popping the first address of the onward route (which should be the worker address)
• push a new return address at the front of the return route (this can be the current worker address but this can also be the address of another worker, depending on the desired topology).

Therefore, a certain number of functions are available on LocalMessage to manipulate the onward and return routes:

• pop_front_onward_route: remove the first address of the onward route
• replace_front_onward_route: replace the first address of the onward route with another address
• push_front_onward_route: add an address at the front of the onward route
• prepend_front_onward_route: prepend a whole route at the front of the onward route
• set_onward_route: set a new route for the onward route

There are similar functions for return routes. All modification functions can be composed. For example:

self.pop_front_onward_route()?.prepend_front_return_route(&new_route)

Implementations

impl LocalMessage

pub fn protocol_version(&self) -> ProtocolVersion

Return the protocol version on the return route

pub fn onward_route(&self) -> Route

Return the message onward route

pub fn onward_route_ref(&self) -> &Route

Return a reference to the message onward route

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

Return the next address on the onward route

pub fn has_next_on_onward_route(&self) -> bool

Return true if an address exists on the onward route

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

Remove the first address of the onward route

pub fn push_front_onward_route(self, address: &Address) -> Self

Prepend an address on the onward route

pub fn replace_front_onward_route(self, address: &Address) -> Result<Self>

Replace the first address on the onward route

pub fn prepend_front_onward_route(self, route: &Route) -> Self

Prepend a route to the onward route

pub fn set_onward_route(self, route: Route) -> Self

Set the message onward route

pub fn return_route(&self) -> Route

Return the message return route

pub fn return_route_ref(&self) -> &Route

Return a reference to the message return route

pub fn set_return_route(self, route: Route) -> Self

Set the message return route

pub fn push_front_return_route(self, address: &Address) -> Self

Prepend an address to the return route

pub fn prepend_front_return_route(self, route: &Route) -> Self

Prepend a route to the return route

pub fn step_forward(self, address: &Address) -> Result<Self>

Remove the first address on the onward route and push another address on the return route

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

Return the message payload

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

Return a reference to the message payload

pub fn payload_mut(&mut self) -> &mut Vec<u8>

Return a mutable reference to the message payload

pub fn set_payload(self, payload: Vec<u8>) -> Self

Set the message payload

pub fn local_info(&self) -> Vec<LocalInfo>

Return the message local info

pub fn local_info_ref(&self) -> &[LocalInfo]

Return a reference to the message local info

pub fn local_info_mut(&mut self) -> &mut Vec<LocalInfo>

Return a mutable reference to the message local info

pub fn clear_local_info(&mut self)

Clear all LocalInfo entries

pub fn tracing_context(&self) -> OpenTelemetryContext

Get the tracing context associated to this local message

pub fn from_transport_message( transport_message: TransportMessage ) -> LocalMessage

Create a LocalMessage from a decoded TransportMessage

pub fn into_transport_message(self) -> TransportMessage

Create a TransportMessage from a LocalMessage

impl LocalMessage

pub fn new() -> Self

Create a LocalMessage with default values, in order to build it with the withXXX methods

pub fn with_onward_route(self, onward_route: Route) -> Self

Specify the onward route for the message

pub fn with_return_route(self, return_route: Route) -> Self

Specify the return route for the message

pub fn with_payload(self, payload: Vec<u8>) -> Self

Specify the payload for the message

pub fn with_local_info(self, local_info: Vec<LocalInfo>) -> Self

Specify the local information for the message

pub fn with_tracing_context(self, tracing_context: OpenTelemetryContext) -> Self

Specify the tracing context

pub fn with_protocol_version(self, protocol_version: ProtocolVersion) -> Self

Specify the version for the message

Trait Implementations

impl Clone for LocalMessage

fn clone(&self) -> LocalMessage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LocalMessage

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

Formats the value using the given formatter.

impl Default for LocalMessage

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for LocalMessage

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for LocalMessage

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for LocalMessage

fn cmp(&self, other: &LocalMessage) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for LocalMessage

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

impl PartialOrd for LocalMessage

fn partial_cmp(&self, other: &LocalMessage) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for LocalMessage

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for LocalMessage

impl Message for LocalMessage

impl StructuralPartialEq for LocalMessage