Struct async_prost::AsyncProstStream

pub struct AsyncProstStream<S, R, W, D> { /* private fields */ }

A wrapper around an async stream that receives and sends prost-encoded values

Implementations

impl<S, R, W, D> AsyncProstStream<S, R, W, D>

pub fn get_ref(&self) -> &S

Gets a reference to the underlying stream.

It is inadvisable to directly read from or write to the underlying stream.

pub fn get_mut(&mut self) -> &mut S

Gets a mutable reference to the underlying stream.

It is inadvisable to directly read from or write to the underlying stream.

pub fn into_inner(self) -> S

Unwraps this AsyncProstStream, returning the underlying stream.

Note that any leftover serialized data that has not yet been sent, or received data that has not yet been deserialized, is lost.

impl<S, R, W, D> AsyncProstStream<S, R, W, D>

pub fn for_async(self) -> AsyncProstStream<S, R, W, AsyncDestination>

make this stream include the serialized data’s size before each serialized value

pub fn for_async_framed(
    self
) -> AsyncProstStream<S, R, W, AsyncFrameDestination>

make this stream include the serialized data’s size before each serialized value

pub fn for_sync(self) -> AsyncProstStream<S, R, W, SyncDestination>

Make this stream only send prost-encoded values

impl<R, W, D> AsyncProstStream<TcpStream, R, W, D>

pub fn tcp_split(
    &mut self
) -> (AsyncProstReader<ReadHalf<'_>, R, D>, AsyncProstWriter<WriteHalf<'_>, W, D>)

split a TCP-based stream into a read half and a write half

Trait Implementations

impl<S: Debug, R: Debug, W: Debug, D: Debug> Debug for AsyncProstStream<S, R, W, D>

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

Formats the value using the given formatter.

impl<S, R, W> Default for AsyncProstStream<S, R, W, SyncDestination> where
    S: Default, 

fn default() -> Self

Returns the “default value” for a type.

impl<S, R, W> From<S> for AsyncProstStream<S, R, W, SyncDestination>

fn from(stream: S) -> Self

Converts to this type from the input type.

impl<S, R, W, D> Sink<W> for AsyncProstStream<S, R, W, D> where
    S: Unpin,
    AsyncProstWriter<S, W, D>: Sink<W, Error = Error>, 

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: W) -> 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<S, R, W, D> Stream for AsyncProstStream<S, R, W, D> where
    S: Unpin,
    AsyncProstReader<InternalAsyncWriter<S, W, D>, R, D>: Stream<Item = Result<R, Error>>, 

type Item = Result<R, 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.