Struct transmog_async::TransmogWriter

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

A wrapper around an asynchronous sink that accepts, serializes, and sends Transmog-encoded values.

To use, provide a writer that implements AsyncWrite, and then use Sink to send values.

Note that an TransmogWriter must be of the type AsyncDestination in order to be compatible with an TransmogReader on the remote end (recall that it requires the serialized size prefixed to the serialized data). The default is SyncDestination, but these can be easily toggled between using TransmogWriter::for_async.

Implementations

impl<W, T, D, F> TransmogWriter<W, T, D, F>

pub fn format(&self) -> &F

Gets a reference to the underlying format.

It is inadvisable to directly write to the underlying writer.

pub fn get_ref(&self) -> &W

Gets a reference to the underlying writer.

It is inadvisable to directly write to the underlying writer.

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

Gets a mutable reference to the underlying writer.

It is inadvisable to directly write to the underlying writer.

pub fn into_inner(self) -> (W, F)

Unwraps this TransmogWriter, returning the underlying writer.

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

impl<W, T, F> TransmogWriter<W, T, SyncDestination, F>

pub fn new(writer: W, format: F) -> Self

Returns a new instance that sends format-encoded data over writer.

pub fn default_for(format: F) -> Self where
    W: Default, 

Returns a new instance that sends format-encoded data over W::defcfault().

impl<W, T, F> TransmogWriter<W, T, SyncDestination, F>

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

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

This is necessary for compatability with TransmogReader.

impl<W, T, F> TransmogWriter<W, T, AsyncDestination, F>

pub fn for_sync(self) -> TransmogWriter<W, T, SyncDestination, F>

Make this writer only send Transmog-encoded values.

This is necessary for compatability with stock Transmog receivers.

Trait Implementations

impl<W: Debug, T: Debug, D: Debug, F: Debug> Debug for TransmogWriter<W, T, D, F>

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

Formats the value using the given formatter.

impl<W, T, D, F> Sink<T> for TransmogWriter<W, T, D, F> where
    F: Format<T>,
    W: AsyncWrite + Unpin,
    Self: TransmogWriterFor<T, F>, 

type Error = F::Error

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

fn poll_ready(
    self: Pin<&mut Self>,
    _: &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, F> Unpin for TransmogWriter<W, T, D, F> where
    W: Unpin,