Struct AsyncWriteTyped

pub struct AsyncWriteTyped<W: AsyncWrite + Unpin, T: Serialize + DeserializeOwned + Unpin> { /* private fields */ }

Provides the ability to write serde compatible types to any type that implements futures::io::AsyncWrite.

Implementations

impl<W: AsyncWrite + Unpin, T: Serialize + DeserializeOwned + Unpin> AsyncWriteTyped<W, T>

pub fn new_with_limit( raw: W, size_limit: u64, checksum_enabled: ChecksumEnabled, ) -> Self

Creates a typed writer, initializing it with the given size limit specified in bytes. Checksums are used to validate that messages arrived without corruption. The checksum will only be used if both the reader and the writer enable it. If either one disables it, then no checking is performed.

Be careful, large size limits might create a vulnerability to a Denial of Service attack.

pub fn new(raw: W, checksum_enabled: ChecksumEnabled) -> Self

Creates a typed writer, initializing it with a default size limit of 1 MB per message. Checksums are used to validate that messages arrived without corruption. The checksum will only be used if both the reader and the writer enable it. If either one disables it, then no checking is performed.

pub fn inner(&self) -> &W

Returns a reference to the raw I/O primitive that this type is using.

pub fn into_inner(self) -> W

Consumes this AsyncWriteTyped and returns the raw I/O primitive that was being used.

pub fn optimize_memory_usage(&mut self)

AsyncWriteTyped keeps a memory buffer for sending values which is the same size as the largest message that’s been sent. If the message size varies a lot, you might find yourself wasting memory space. This function will reduce the memory usage as much as is possible without impeding functioning. Overuse of this function may cause excessive memory allocations when the buffer needs to grow.

pub fn current_memory_usage(&self) -> usize

Reports the size of the memory buffer used for sending values. You can shrink this buffer as much as possible with Self::optimize_memory_usage.

pub fn checksum_enabled(&self) -> bool

Returns true if checksums are enabled for this channel. This does not guarantee that the reader is actually using those checksum values, it only reflects whether checksums are being sent.

Trait Implementations

impl<W: Debug + AsyncWrite + Unpin, T: Debug + Serialize + DeserializeOwned + Unpin> Debug for AsyncWriteTyped<W, T>

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

Formats the value using the given formatter.

impl<W: AsyncWrite + Unpin, T: Serialize + DeserializeOwned + Unpin> Drop for AsyncWriteTyped<W, T>

fn drop(&mut self)

Executes the destructor for this type.

impl<W: AsyncWrite + Unpin, T: Serialize + DeserializeOwned + Unpin> Sink<T> for AsyncWriteTyped<W, 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.