Struct async_prost::AsyncProstWriter

pub struct AsyncProstWriter<W, T, D> { /* fields omitted */ }

A warpper around an async sink that accepts, serializes, and sends prost-encoded values.

Implementations

impl<W, T, D> AsyncProstWriter<W, T, D>

pub fn new(writer: W) -> Self

create a new async prost writer

pub fn get_ref(&self) -> &W

Gets a reference to the underlying writer.

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

Gets a mutable reference to the underlying writer.

pub fn into_inner(self) -> W

Unwraps this AsyncProstWriter, returning the underlying writer.

Note that any leftover serialized data that has not yet been sent is lost.

impl<W, T> AsyncProstWriter<W, T, SyncDestination>

pub fn for_async(self) -> AsyncProstWriter<W, T, AsyncDestination>

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

pub fn for_async_framed(self) -> AsyncProstWriter<W, T, AsyncFrameDestination>

make this writer include the serialized data’s header and body size before serialized value

Trait Implementations

impl<W: Debug, T: Debug, D: Debug> Debug for AsyncProstWriter<W, T, D>

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

Formats the value using the given formatter.

impl<W, T> Default for AsyncProstWriter<W, T, SyncDestination> where
    W: Default, 

fn default() -> Self

Returns the “default value” for a type.

impl<W, T> From<W> for AsyncProstWriter<W, T, SyncDestination>

fn from(writer: W) -> Self

Performs the conversion.

impl<W, T, D> Sink<T> for AsyncProstWriter<W, T, D> where
    W: AsyncWrite + Unpin,
    Self: ProstWriterFor<T>, 

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<W, T, D> Unpin for AsyncProstWriter<W, T, D>