Struct BidiFramed

pub struct BidiFramed<T, WH, RH> { /* private fields */ }

Framed transport codec for streams

Wraps a stream S and allows sending packetized data of type T over it. Data items are encoded using bincode and the bytes are sent over the stream prepended with a length field. BidiFramed implements Sink<T> and Stream<Item=Result<T, _>>.

Implementations

impl<T, WH, RH> BidiFramed<T, WH, RH>

where WH: AsyncWrite, RH: AsyncRead, T: Serialize + DeserializeOwned,

pub fn new<S>(stream: S) -> BidiFramed<T, WriteHalf<S>, ReadHalf<S>>

where S: AsyncRead + AsyncWrite,

Builds a new BidiFramed codec around a stream stream.

See TcpBidiFramed::new_from_tcp for a more efficient version in case the stream is a tokio TCP stream.

pub fn borrow_parts( &mut self, ) -> (&mut FramedSink<WH, T>, &mut FramedStream<RH, T>)

Splits the codec in its sending and receiving parts

This can be useful in cases where potentially simultaneous read and write operations are required. Otherwise a we would need a mutex to guard access.

impl<T> BidiFramed<T, OwnedWriteHalf, OwnedReadHalf>

where T: Serialize + DeserializeOwned,

pub fn new_from_tcp(stream: TcpStream) -> TcpBidiFramed<T>

Special constructor for tokio TCP connections.

Tokio TcpStream implements an efficient method of splitting the stream into a read and a write half this constructor takes advantage of.

Trait Implementations

impl<T: Debug, WH: Debug, RH: Debug> Debug for BidiFramed<T, WH, RH>

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

Formats the value using the given formatter.

impl<T, WH, RH> FramedTransport<T> for BidiFramed<T, WH, RH>

where T: Debug + Serialize + DeserializeOwned + Send, WH: AsyncWrite + Send + Unpin, RH: AsyncRead + Send + Unpin,

fn borrow_split( &mut self, ) -> (&mut (dyn Sink<T, Error = Error> + Send + Unpin), &mut (dyn Stream<Item = Result<T, Error>> + Send + Unpin))

Split the framed transport into read and write half

fn into_dyn(self) -> AnyFramedTransport<T>

where Self: Sized + Send + Unpin + 'static,

Transforms concrete FramedTransport object into an owned trait object

impl<T, WH, RH> Sink<T> for BidiFramed<T, WH, RH>

where WH: AsyncWrite + Unpin, RH: Unpin, T: Debug + Serialize,

type Error = Error

The type of value produced by the sink when an error occurs.

fn poll_ready( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Result<(), Self::Error>>

Attempts to prepare the Sink to receive a value.

fn start_send(self: Pin<&mut Self>, item: T) -> Result<(), Self::Error>

Begin the process of sending a value to the sink. Each call to this function must be preceded by a successful call to poll_ready which returned Poll::Ready(Ok(())).

fn poll_flush( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Result<(), Self::Error>>

Flush any remaining output from this sink.

fn poll_close( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Result<(), Self::Error>>

Flush any remaining output and close this sink, if necessary.

impl<T, WH, RH> Stream for BidiFramed<T, WH, RH>

where T: DeserializeOwned, WH: Unpin, RH: AsyncRead + Unpin,

type Item = Result<T, Error>

Values yielded by the stream.

fn poll_next( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.