Struct ockam::TransportMessage[−][src]

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

Expand description

A generic transport message

While 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.

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

The message payload

Implementations

[src]

impl TransportMessage

[src]

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

Create a new v1 transport message with empty return route

Trait Implementations

[src]

impl Clone for TransportMessage

[src]

pub fn clone(&self) -> TransportMessage

Returns a copy of the value. Read more

1.0.0[src]

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

Performs copy-assignment from source. Read more

[src]

impl Debug for TransportMessage

[src]

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

Formats the value using the given formatter. Read more

[src]

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

[src]

pub 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

[src]

impl Display for TransportMessage

[src]

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

Formats the value using the given formatter. Read more

[src]

impl Hash for TransportMessage

[src]

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

Feeds this value into the given Hasher. Read more

1.3.0[src]

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

Feeds a slice of this type into the given Hasher. Read more

[src]

impl Ord for TransportMessage

[src]

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

This method returns an Ordering between self and other. Read more

1.21.0[src]

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

Compares and returns the maximum of two values. Read more

1.21.0[src]

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

Compares and returns the minimum of two values. Read more

1.50.0[src]

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

Restrict a value to a certain interval. Read more

[src]

impl PartialEq<TransportMessage> for TransportMessage

[src]

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

This method tests for self and other values to be equal, and is used by ==. Read more

[src]

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

This method tests for !=.

[src]

impl PartialOrd<TransportMessage> for TransportMessage

[src]

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

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

1.0.0[src]

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

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

1.0.0[src]

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 more

1.0.0[src]

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

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

1.0.0[src]

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

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

[src]

impl Serialize for TransportMessage

[src]

pub 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

[src]

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

[src]

impl<T> Any for T where
T: 'static + ?Sized,

[src]

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

[src]

impl<D> AsyncTryClone for D where
D: Clone + Sync,

[src]

pub fn async_try_clone<'life0, 'async_trait>(
 &'life0 self
) -> Pin<Box<dyn Future<Output = Result<D, Error>> + Send + 'async_trait, Global>>ⓘ
Notable traits for Pin
`impl Future for Pin where P: DerefMut, ::Target: Future, type Output = <::Target as Future>::Output;`
where
 'life0: 'async_trait,
 D: 'async_trait,

Try cloning a object and return an Err in case of failure.

[src]

impl<T> Borrow<T> for T where
T: ?Sized,

[src]

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

[src]

impl<T> BorrowMut<T> for T where
T: ?Sized,

[src]

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CallHasher for T where
T: Hash + ?Sized,

pub default fn get_hash<H, B>(value: &H, build_hasher: &B) -> u64 where
H: Hash + ?Sized,
B: BuildHasher,

[src]

impl<T> Decodable for T where
T: DeserializeOwned,

[src]

pub fn decode(encoded: &[u8 ]) -> Result<T, Error>

Decode a slice.

[src]

impl<T> Encodable for T where
T: Serialize,

[src]

pub fn encode(&self) -> Result<Vec<u8, Global>, Error>

Encode the type into an Encoded type.

[src]

impl<T> From<T> for T

[src]

pub fn from(t: T) -> T

Performs the conversion.

[src]

impl<T> Instrument for T

[src]

fn instrument(self, span: Span) -> Instrumented<Self>ⓘ
Notable traits for Instrumented<T>
`impl<T> Future for Instrumented<T> where T: Future, type Output = <T as Future>::Output;`

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

[src]

fn in_current_span(self) -> Instrumented<Self>ⓘ
Notable traits for Instrumented<T>
`impl<T> Future for Instrumented<T> where T: Future, type Output = <T as Future>::Output;`

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

[src]

impl<T, U> Into for T where
U: From<T>,

[src]

pub fn into(self) -> U

Performs the conversion.

[src]

impl<T> Same<T> for T

type Output = T

Should always be Self

[src]

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

[src]

pub fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

[src]

pub fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

[src]

impl<T> ToString for T where
T: Display + ?Sized,

[src]

pub default fn to_string(&self) -> String

Converts the given value to a String. Read more

[src]

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

[src]

pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

[src]

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

[src]

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

pub fn vzip(self) -> V

[src]

impl<T> WithSubscriber for T

[src]

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>ⓘ
Notable traits for WithDispatch<T>
`impl<T> Future for WithDispatch<T> where T: Future, type Output = <T as Future>::Output;`
where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

[src]

fn with_current_subscriber(self) -> WithDispatch<Self>ⓘ
Notable traits for WithDispatch<T>
`impl<T> Future for WithDispatch<T> where T: Future, type Output = <T as Future>::Output;`

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

[src]

Struct ockam::TransportMessage[−][src]

Fields

Implementations

impl TransportMessage

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

Trait Implementations

impl Clone for TransportMessage

pub fn clone(&self) -> TransportMessage

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

impl Debug for TransportMessage

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

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

pub fn deserialize<__D>( __deserializer: __D) -> Result<TransportMessage, <__D as Deserializer<'de>>::Error> where __D: Deserializer<'de>,

impl Display for TransportMessage

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

impl Hash for TransportMessage

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

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

impl Ord for TransportMessage

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

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

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

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

impl PartialEq<TransportMessage> for TransportMessage

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

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

impl PartialOrd<TransportMessage> for TransportMessage

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

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

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

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

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

impl Serialize for TransportMessage

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

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

impl<T> Any for T where T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

impl<D> AsyncTryClone for D where D: Clone + Sync,

impl<T> Borrow<T> for T where T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

impl<T> CallHasher for T where T: Hash + ?Sized,

pub default fn get_hash<H, B>(value: &H, build_hasher: &B) -> u64 where H: Hash + ?Sized, B: BuildHasher,

impl<T> Decodable for T where T: DeserializeOwned,

pub fn decode(encoded: &[u8]) -> Result<T, Error>

impl<T> Encodable for T where T: Serialize,

pub fn encode(&self) -> Result<Vec<u8, Global>, Error>

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where T: Future, type Output = <T as Future>::Output;

fn in_current_span(self) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where T: Future, type Output = <T as Future>::Output;

impl<T, U> Into<U> for T where U: From<T>,

pub fn into(self) -> U

impl<T> Same<T> for T

type Output = T

impl<T> ToOwned for T where T: Clone,

type Owned = T

pub fn to_owned(&self) -> T

pub fn clone_into(&self, target: &mut T)

impl<T> ToString for T where T: Display + ?Sized,

pub default fn to_string(&self) -> String

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<V, T> VZip<V> for T where V: MultiLane<T>,

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

pub fn deserialize<D>(
deserializer: D
) -> Result<TransportMessage, <D as Deserializer<'de>>::Error> where
__D: Deserializer<'de>,

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

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

pub fn serialize<S>(
&self,
serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error> where
S: Serializer,

impl<T> Any for T where
T: 'static + ?Sized,

impl<D> AsyncTryClone for D where
D: Clone + Sync,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T> CallHasher for T where
T: Hash + ?Sized,

pub default fn get_hash<H, B>(value: &H, build_hasher: &B) -> u64 where
H: Hash + ?Sized,
B: BuildHasher,

impl<T> Decodable for T where
T: DeserializeOwned,

pub fn decode(encoded: &[u8 ]) -> Result<T, Error>

impl<T> Encodable for T where
T: Serialize,

fn instrument(self, span: Span) -> Instrumented<Self>ⓘ
Notable traits for Instrumented<T>
`impl<T> Future for Instrumented<T> where T: Future, type Output = <T as Future>::Output;`

fn in_current_span(self) -> Instrumented<Self>ⓘ
Notable traits for Instrumented<T>
`impl<T> Future for Instrumented<T> where T: Future, type Output = <T as Future>::Output;`

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T> ToString for T where
T: Display + ?Sized,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>ⓘ
Notable traits for WithDispatch<T>
`impl<T> Future for WithDispatch<T> where T: Future, type Output = <T as Future>::Output;`
where
S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>ⓘ
Notable traits for WithDispatch<T>
`impl<T> Future for WithDispatch<T> where T: Future, type Output = <T as Future>::Output;`

impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,