Struct ockam_core::LocalMessage

pub struct LocalMessage { /* private fields */ }

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

LocalMessage consists of a TransportMessage and LocalInfo in binary format, that can be added by Workers within the same node.

Transport Messages are used to transfer messages between different nodes using Transport Workers. Upon arrival at a receiving Transport Worker, TransportMessage is wrapped inside LocalMessage and forwarded to other Workers inside that node.

LocalMessage provides a mechanism for transporting metadata that is trusted to come from the same node. This is convenient for delegating Authentication/Authorization mechanisms to dedicated local Workers.

This type is exposed in ockam_core (and the root ockam crate) in order to provide a mechanism for third-party developers to create custom transport channel routers.

Casual users of Ockam should never have to interact with this type directly.

Examples

See ockam_transport_tcp::workers::receiver::TcpRecvProcessor for a usage example.

Implementations

impl LocalMessage

pub fn into_transport_message(self) -> TransportMessage

Consumes the message and returns the underlying transport message.

pub fn transport(&self) -> &TransportMessage

Return a reference to the underlying transport message.

pub fn transport_mut(&mut self) -> &mut TransportMessage

Return a mutable reference to the underlying transport message.

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

Return a reference to local information added by Workers within the same node.

pub fn dissolve(self) -> (TransportMessage, Vec<LocalInfo>)

Dissolve

impl LocalMessage

pub fn append_local_info(&mut self, local_info: LocalInfo)

Append a new LocalInfo entry.

pub fn replace_local_info(&mut self, local_info: LocalInfo)

Replace all LocalInfo entries matching the type identifier of the given LocalInfo with itself.

pub fn clear_local_info(&mut self, type_identifier: &str)

Clear all LocalInfo entries with the given type identifier.

impl LocalMessage

pub fn new(
    transport_message: TransportMessage,
    local_info: Vec<LocalInfo>
) -> Self

Create a new LocalMessage from the provided transport message and local information.

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<'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,

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<LocalMessage> 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<LocalMessage> 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 StructuralEq for LocalMessage

impl StructuralPartialEq for LocalMessage