Struct ockam::TransportMessage
source · pub struct TransportMessage {
pub version: u8,
pub onward_route: Route,
pub return_route: Route,
pub payload: Vec<u8>,
}
Expand description
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§
Trait Implementations§
source§impl Clone for TransportMessage
impl Clone for TransportMessage
source§fn clone(&self) -> TransportMessage
fn clone(&self) -> TransportMessage
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresource§impl Debug for TransportMessage
impl Debug for TransportMessage
source§impl<'de> Deserialize<'de> for TransportMessage
impl<'de> Deserialize<'de> for TransportMessage
source§fn deserialize<__D>(
__deserializer: __D
) -> Result<TransportMessage, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(
__deserializer: __D
) -> Result<TransportMessage, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
source§impl Display for TransportMessage
impl Display for TransportMessage
source§impl Hash for TransportMessage
impl Hash for TransportMessage
source§impl Ord for TransportMessage
impl Ord for TransportMessage
source§fn cmp(&self, other: &TransportMessage) -> Ordering
fn cmp(&self, other: &TransportMessage) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
Compares and returns the maximum of two values. Read more
source§impl PartialEq for TransportMessage
impl PartialEq for TransportMessage
source§fn eq(&self, other: &TransportMessage) -> bool
fn eq(&self, other: &TransportMessage) -> bool
This method tests for
self
and other
values to be equal, and is used
by ==
.source§impl PartialOrd for TransportMessage
impl PartialOrd for TransportMessage
source§fn partial_cmp(&self, other: &TransportMessage) -> Option<Ordering>
fn partial_cmp(&self, other: &TransportMessage) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for
self
and other
) and is used by the <=
operator. Read moresource§impl Serialize for TransportMessage
impl Serialize for TransportMessage
source§fn serialize<__S>(
&self,
__serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
fn serialize<__S>(
&self,
__serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
Serialize this value into the given Serde serializer. Read more
impl Eq for TransportMessage
impl Message for TransportMessage
impl StructuralEq for TransportMessage
impl StructuralPartialEq for TransportMessage
Auto Trait Implementations§
impl RefUnwindSafe for TransportMessage
impl Send for TransportMessage
impl Sync for TransportMessage
impl Unpin for TransportMessage
impl UnwindSafe for TransportMessage
Blanket Implementations§
source§impl<D> AsyncTryClone for D
impl<D> AsyncTryClone for D
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
§impl<Q, K> Comparable<K> for Q
impl<Q, K> Comparable<K> for Q
source§impl<T> Decodable for Twhere
T: DeserializeOwned,
impl<T> Decodable for Twhere
T: DeserializeOwned,
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
Checks if this value is equivalent to the given key. Read more
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
Compare self to
key
and return true
if they are equal.