Struct TransportMessage

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

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: ProtocolVersion

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.

tracing_context: Option<String>

An optional tracing context

Implementations

impl TransportMessage

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

Create the latest version of a transport message with an empty return route.

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

Create a transport message in version v1

pub fn new( version: ProtocolVersion, onward_route: impl Into<Route>, return_route: impl Into<Route>, payload: Vec<u8>, tracing_context: Option<String>, ) -> Self

Create a new transport message

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

Specify the tracing context

pub fn decode_message(buf: Vec<u8>) -> Result<TransportMessage>

Decode the transport message according to the first byte, which is the version number

pub fn tracing_context(&self) -> OpenTelemetryContext

Return the tracing context

Trait Implementations

impl Clone for TransportMessage

fn clone(&self) -> TransportMessage

Returns a duplicate of the value.

const 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 Decodable for TransportMessage

fn decode(slice: &[u8]) -> Result<Self>

Decode a slice.

impl Display for TransportMessage

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

Formats the value using the given formatter.

impl Encodable for TransportMessage

fn encode(self) -> Result<Encoded>

Encode the type into an Encoded type.

impl PartialEq for TransportMessage

fn eq(&self, other: &TransportMessage) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for TransportMessage

impl Message for TransportMessage

impl StructuralPartialEq for TransportMessage