Struct fizyr_rpc::transport::StreamTransport

pub struct StreamTransport<Stream> { /* private fields */ }

Transport layer for byte-stream sockets.

Implementations

impl<Stream> StreamTransport<Stream>

where Self: Transport,

pub fn new(stream: Stream, config: StreamConfig) -> Self

Create a new transport with custom configuration.

pub fn new_default(stream: Stream) -> Self

Create a new transport using the default configuration.

pub fn stream(&self) -> &Stream

Get direct access to the underlying stream.

pub fn stream_mut(&mut self) -> &Stream

Get direct mutable access to the underlying stream.

pub fn into_stream(self) -> Stream

Consume the stream transport to retrieve the underlying stream.

Trait Implementations

impl<'a, Address> Connect<'a, Address> for StreamTransport<TcpStream>

where Address: ToSocketAddrs + 'a,

type Future = Pin<Box<dyn Future<Output = Result<StreamTransport<TcpStream>, Error>> + 'a>>

The type of the future returned by Self::connect.

fn connect(address: Address, config: Self::Config) -> Self::Future

Create a new transport connected to a remote address.

impl<'a, Address> Connect<'a, Address> for StreamTransport<UnixStream>

where Address: AsRef<Path> + 'a,

type Future = Pin<Box<dyn Future<Output = Result<StreamTransport<UnixStream>, Error>> + 'a>>

The type of the future returned by Self::connect.

fn connect(address: Address, config: Self::Config) -> Self::Future

Create a new transport connected to a remote address.

impl Transport for StreamTransport<TcpStream>

type Body = StreamBody

The body type for the messages.

type Info = TcpStreamInfo

Information about the underlying stream or connection of the transport.

type Config = StreamConfig

The configuration type for the transport.

type ReadHalf<'a> = StreamReadHalf<ReadHalf<'a>>

The type of the read half of the transport.

type WriteHalf<'a> = StreamWriteHalf<WriteHalf<'a>>

The type of the write half of the transport.

fn split( &mut self ) -> (StreamReadHalf<ReadHalf<'_>>, StreamWriteHalf<WriteHalf<'_>>)

Split the transport into a read half and a write half.

fn info(&self) -> Result<Self::Info>

Get information about the peer on the other end of the transport.

impl Transport for StreamTransport<UnixStream>

type Body = StreamBody

The body type for the messages.

type Info = UnixStreamInfo

Information about the underlying stream or connection of the transport.

type Config = StreamConfig

The configuration type for the transport.

type ReadHalf<'a> = StreamReadHalf<ReadHalf<'a>>

The type of the read half of the transport.

type WriteHalf<'a> = StreamWriteHalf<WriteHalf<'a>>

The type of the write half of the transport.

fn split( &mut self ) -> (StreamReadHalf<ReadHalf<'_>>, StreamWriteHalf<WriteHalf<'_>>)

Split the transport into a read half and a write half.

fn info(&self) -> Result<Self::Info>

Get information about the peer on the other end of the transport.