Struct ockam_core::TransportMessage

pub struct TransportMessage {
    pub version: u8,
    pub onward_route: Route,
    pub return_route: Route,
    pub payload: Vec<u8>,
}

A generic transport message type.

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::sender::TcpSendWorker for a usage example.

Fields

version: u8

The transport protocol version.

onward_route: Route

Onward message route.

return_route: Route

Return message route.

This field must be populated by routers handling this message along the way.

payload: Vec<u8>

The message payload.

Implementations

impl TransportMessage

pub fn v1( onward_route: impl Into<Route>, return_route: impl Into<Route>, payload: Vec<u8> ) -> Self

Create a new v1 transport message with empty return route.

Trait Implementations

impl Clone for TransportMessage

fn clone(&self) -> TransportMessage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TransportMessage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TransportMessage

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for TransportMessage

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

Formats the value using the given formatter.

impl Hash for TransportMessage

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 TransportMessage

fn cmp(&self, other: &TransportMessage) -> 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 TransportMessage

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

fn partial_cmp(&self, other: &TransportMessage) -> 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 TransportMessage

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 TransportMessage

impl Message for TransportMessage

impl StructuralEq for TransportMessage

impl StructuralPartialEq for TransportMessage