Struct distant_net::FramedTransport

pub struct FramedTransport<T, C>(_) 
where
    T: RawTransport,
    C: Codec;

Represents [TypedTransport] of data across the network using frames in order to support typed messages instead of arbitrary bytes being sent across the wire.

Note that this type does not implement RawTransport and instead acts as a wrapper around a transport to provide a higher-level interface

Implementations

impl<T, C> FramedTransport<T, C> where
    T: RawTransport,
    C: Codec, 

pub fn new(transport: T, codec: C) -> Self

Creates a new instance of the transport, wrapping the stream in a Framed<T, XChaCha20Poly1305Codec>

impl FramedTransport<InmemoryTransport, PlainCodec>

pub fn pair(
    buffer: usize
) -> (FramedTransport<InmemoryTransport, PlainCodec>, FramedTransport<InmemoryTransport, PlainCodec>)

Produces a pair of inmemory transports that are connected to each other using a standard codec

Sets the buffer for message passing for each underlying transport to the given buffer size

Trait Implementations

impl<T: Debug, C: Debug> Debug for FramedTransport<T, C> where
    T: RawTransport,
    C: Codec, 

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

Formats the value using the given formatter.

impl<T, C> IntoSplit for FramedTransport<T, C> where
    T: RawTransport + IntoSplit,
    <T as IntoSplit>::Read: RawTransportRead,
    <T as IntoSplit>::Write: RawTransportWrite,
    C: Codec + Send, 

type Read = FramedTransportReadHalf<<T as IntoSplit>::Read, C>

type Write = FramedTransportWriteHalf<<T as IntoSplit>::Write, C>

fn into_split(self) -> (Self::Write, Self::Read)

impl<T, C> UntypedTransportRead for FramedTransport<T, C> where
    T: RawTransport + Send,
    C: Codec + Send, 

fn read<'life0, 'async_trait, D>(
    &'life0 mut self
) -> Pin<Box<dyn Future<Output = Result<Option<D>>> + Send + 'async_trait>> where
    D: DeserializeOwned,
    D: 'async_trait,
    'life0: 'async_trait,
    Self: 'async_trait, 

Attempts to read some data as T, returning io::Error if unable to deserialize or some other error occurs. Some(T) is returned if successful. None is returned if no more data is available.

impl<T, C> UntypedTransportWrite for FramedTransport<T, C> where
    T: RawTransport + Send,
    C: Codec + Send, 

fn write<'life0, 'async_trait, D>(
    &'life0 mut self,
    data: D
) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>> where
    D: Serialize + Send + 'static,
    D: 'async_trait,
    'life0: 'async_trait,
    Self: 'async_trait, 

Attempts to write some data of type T, returning io::Error if unable to serialize or some other error occurs.

impl<T, C> UntypedTransport for FramedTransport<T, C> where
    T: RawTransport,
    C: Codec + Send,