Struct async_read_length_limit::LengthLimit

pub struct LengthLimit<T> { /* private fields */ }

AsyncRead length limiter

The number of bytes will never be more than the provided byte limit. If the byte limit is exactly the length of the contained AsyncRead, it is considered an error.

Errors

This will return an error if the underlying AsyncRead does so or if the read length meets (or would exceed) the provided length limit. The returned std::io::Error will have an error kind of ErrorKind::InvalidData and a contained error of LengthLimitExceeded.

Implementations

impl<T> LengthLimit<T>

where T: AsyncRead,

pub fn new(reader: T, max_bytes: usize) -> Self

Constructs a new LengthLimit with provided AsyncRead reader and max_bytes byte length

pub fn bytes_remaining(&self) -> usize

Returns the number of additional bytes before the limit is reached

pub fn into_inner(self) -> T

Unwraps the contained AsyncRead, allowing it to be read to completion. bytes remaining data are discarded

Trait Implementations

impl<T> AsRef<T> for LengthLimit<T>

fn as_ref(&self) -> &T

Converts this type into a shared reference of the (usually inferred) input type.

impl<T: AsyncRead> AsyncRead for LengthLimit<T>

fn poll_read( self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &mut [u8] ) -> Poll<Result<usize>>

Attempt to read from the AsyncRead into buf.

fn poll_read_vectored( self: Pin<&mut Self>, cx: &mut Context<'_>, bufs: &mut [IoSliceMut<'_>] ) -> Poll<Result<usize, Error>>

Attempt to read from the AsyncRead into bufs using vectored IO operations.

impl<T: Clone> Clone for LengthLimit<T>

fn clone(&self) -> LengthLimit<T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug> Debug for LengthLimit<T>

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

Formats the value using the given formatter.

impl<T: Copy> Copy for LengthLimit<T>

impl<'__pin, T> Unpin for LengthLimit<T>

where __Origin<'__pin, T>: Unpin,