Struct distant_core::Transport

pub struct Transport<T, U>(_)
 where
    T: DataStream,
    U: Codec;

Represents a transport of data across the network

Implementations

impl Transport<InmemoryStream, PlainCodec>

pub fn pair(
    buffer: usize
) -> (Transport<InmemoryStream, PlainCodec>, Transport<InmemoryStream, 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 stream to the given buffer size

impl<U: Codec> Transport<TcpStream, U>

pub async fn connect(addrs: impl ToSocketAddrs, codec: U) -> Result<Self>

Establishes a connection to one of the specified addresses and uses the provided codec for transportation

pub fn peer_addr(&self) -> Result<SocketAddr>

Returns the address of the peer the transport is connected to

impl<T, U> Transport<T, U> where
    T: DataStream,
    U: Codec, 

pub fn new(stream: T, codec: U) -> Self

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

pub async fn send<D: Serialize>(
    &mut self,
    data: D
) -> Result<(), TransportError>

Sends some data across the wire, waiting for it to completely send

pub async fn receive<R: DeserializeOwned>(
    &mut self
) -> Result<Option<R>, TransportError>

Receives some data from out on the wire, waiting until it’s available, returning none if the transport is now closed

pub fn to_connection_tag(&self) -> String

Returns a textual description of the transport’s underlying connection

pub fn into_split(
    self
) -> (TransportReadHalf<T::Read, U>, TransportWriteHalf<T::Write, U>)

Splits transport into read and write halves

Trait Implementations

impl<T: Debug, U: Debug> Debug for Transport<T, U> where
    T: DataStream,
    U: Codec, 

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

Formats the value using the given formatter.