Struct DuplexStreamTyped

pub struct DuplexStreamTyped<RW: AsyncRead + AsyncWrite + Unpin, T: Serialize + DeserializeOwned + Unpin> { /* private fields */ }

A duplex async connection for sending and receiving messages of a particular type.

Implementations

impl<RW: AsyncRead + AsyncWrite + Unpin, T: Serialize + DeserializeOwned + Unpin> DuplexStreamTyped<RW, T>

pub fn new_with_limit( rw: RW, size_limit: u64, checksum_enabled: ChecksumEnabled, ) -> Self

Creates a duplex typed reader and 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(rw: RW, checksum_enabled: ChecksumEnabled) -> Self

Creates a duplex typed reader and 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) -> &RW

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

pub fn into_inner(self) -> RW

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

pub fn optimize_memory_usage(&mut self)

DuplexStreamTyped keeps memory buffers for sending and receiving values which are the same size as the largest message that’s been sent or received. 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 buffers used for sending and receiving values. You can shrink these buffers as much as possible with Self::optimize_memory_usage.

pub fn checksum_send_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.

pub fn checksum_receive_enabled(&self) -> bool

Returns true if checksums are enabled for this channel. This may become false after receiving the first value. If that happens, the writer may have disabled checksums, so there is no checksum for the reader to check.

Trait Implementations

impl<RW: Debug + AsyncRead + AsyncWrite + Unpin, T: Debug + Serialize + DeserializeOwned + Unpin> Debug for DuplexStreamTyped<RW, T>

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

Formats the value using the given formatter.

impl<RW: AsyncRead + AsyncWrite + Unpin, T: Serialize + Unpin + DeserializeOwned> Drop for DuplexStreamTyped<RW, T>

fn drop(&mut self)

Executes the destructor for this type.

impl<RW: AsyncRead + AsyncWrite + Unpin, T: Serialize + DeserializeOwned + Unpin> Sink<T> for DuplexStreamTyped<RW, 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<RW: AsyncRead + AsyncWrite + Unpin, T: Serialize + DeserializeOwned + Unpin> Stream for DuplexStreamTyped<RW, T>

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.