Struct async_io_typed::AsyncReadTyped

pub struct AsyncReadTyped<R, T: Serialize + DeserializeOwned + Unpin> { /* private fields */ }

Provides the ability to read serde compatible types from any type that implements futures::io::AsyncRead.

Implementations

impl<R: AsyncRead + Unpin, T: Serialize + DeserializeOwned + Unpin> AsyncReadTyped<R, T>

pub fn new_with_limit(raw: R, size_limit: u64, checksum_enabled: bool) -> Self

Creates a typed reader, initializing it with the given size limit specified in bytes.

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

pub fn new(raw: R, checksum_enabled: bool) -> Self

Creates a typed reader, initializing it with a default size limit of 1 MB.

pub fn inner(&self) -> &R

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

pub fn into_inner(self) -> R

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

pub fn optimize_memory_usage(&mut self)

AsyncReadTyped keeps a memory buffer for receiving values which is the same size as the largest message that’s been 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 buffer used for receiving 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 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<R: Debug, T: Debug + Serialize + DeserializeOwned + Unpin> Debug for AsyncReadTyped<R, T>

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

Formats the value using the given formatter.

impl<R: AsyncRead + Unpin, T: Serialize + DeserializeOwned + Unpin> Stream for AsyncReadTyped<R, 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.