pub struct Limited<Io> { /* private fields */ }Expand description
I/O wrapper that limits the number of bytes written or read on each call.
See the limited and limited_write methods.
Implementations
sourceimpl<Io> Limited<Io>
impl<Io> Limited<Io>
sourcepub fn get_ref(&self) -> &Io
pub fn get_ref(&self) -> &Io
Acquires a reference to the underlying I/O object that this adaptor is wrapping.
sourcepub fn get_mut(&mut self) -> &mut Io
pub fn get_mut(&mut self) -> &mut Io
Acquires a mutable reference to the underlying I/O object that this adaptor is wrapping.
sourcepub fn get_pin_mut(self: Pin<&mut Self>) -> Pin<&mut Io>ⓘNotable traits for Pin<P>impl<P> Future for Pin<P> where
P: DerefMut,
<P as Deref>::Target: Future, type Output = <<P as Deref>::Target as Future>::Output;
pub fn get_pin_mut(self: Pin<&mut Self>) -> Pin<&mut Io>ⓘNotable traits for Pin<P>impl<P> Future for Pin<P> where
P: DerefMut,
<P as Deref>::Target: Future, type Output = <<P as Deref>::Target as Future>::Output;
P: DerefMut,
<P as Deref>::Target: Future, type Output = <<P as Deref>::Target as Future>::Output;
Acquires a pinned mutable reference to the underlying I/O object that this adaptor is wrapping.
sourcepub fn into_inner(self) -> Io
pub fn into_inner(self) -> Io
Consumes this adaptor returning the underlying I/O object.
Trait Implementations
sourceimpl<R: AsyncBufRead> AsyncBufRead for Limited<R>
impl<R: AsyncBufRead> AsyncBufRead for Limited<R>
sourceimpl<R: AsyncRead> AsyncRead for Limited<R>
impl<R: AsyncRead> AsyncRead for Limited<R>
sourceimpl<W: AsyncWrite> AsyncWrite for Limited<W>
impl<W: AsyncWrite> AsyncWrite for Limited<W>
sourcefn poll_write(
self: Pin<&mut Self>,
cx: &mut Context<'_>,
buf: &[u8]
) -> Poll<Result<usize>>
fn poll_write(
self: Pin<&mut Self>,
cx: &mut Context<'_>,
buf: &[u8]
) -> Poll<Result<usize>>
Attempt to write bytes from buf into the object. Read more
sourcefn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<()>>
fn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<()>>
Attempt to flush the object, ensuring that any buffered data reach their destination. Read more
impl<'pin, Io> Unpin for Limited<Io> where
__Limited<'pin, Io>: Unpin,
Auto Trait Implementations
impl<Io> RefUnwindSafe for Limited<Io> where
Io: RefUnwindSafe,
impl<Io> Send for Limited<Io> where
Io: Send,
impl<Io> Sync for Limited<Io> where
Io: Sync,
impl<Io> UnwindSafe for Limited<Io> where
Io: UnwindSafe,
Blanket Implementations
sourceimpl<R> AsyncBufReadExt for R where
R: AsyncBufRead + ?Sized,
impl<R> AsyncBufReadExt for R where
R: AsyncBufRead + ?Sized,
sourcefn fill_buf(&mut self) -> FillBuf<'_, Self>ⓘNotable traits for FillBuf<'a, R>impl<'a, R> Future for FillBuf<'a, R> where
R: AsyncBufRead + Unpin + ?Sized, type Output = Result<&'a [u8], Error>; where
Self: Unpin,
fn fill_buf(&mut self) -> FillBuf<'_, Self>ⓘNotable traits for FillBuf<'a, R>impl<'a, R> Future for FillBuf<'a, R> where
R: AsyncBufRead + Unpin + ?Sized, type Output = Result<&'a [u8], Error>; where
Self: Unpin,
R: AsyncBufRead + Unpin + ?Sized, type Output = Result<&'a [u8], Error>;
Creates a future which will wait for a non-empty buffer to be available from this I/O object or EOF to be reached. Read more
sourcefn consume_unpin(&mut self, amt: usize) where
Self: Unpin,
fn consume_unpin(&mut self, amt: usize) where
Self: Unpin,
A convenience for calling AsyncBufRead::consume on Unpin IO types. Read more
sourcefn read_until(
&'a mut self,
byte: u8,
buf: &'a mut Vec<u8, Global>
) -> ReadUntil<'a, Self>ⓘNotable traits for ReadUntil<'_, R>impl<'_, R> Future for ReadUntil<'_, R> where
R: AsyncBufRead + Unpin + ?Sized, type Output = Result<usize, Error>; where
Self: Unpin,
fn read_until(
&'a mut self,
byte: u8,
buf: &'a mut Vec<u8, Global>
) -> ReadUntil<'a, Self>ⓘNotable traits for ReadUntil<'_, R>impl<'_, R> Future for ReadUntil<'_, R> where
R: AsyncBufRead + Unpin + ?Sized, type Output = Result<usize, Error>; where
Self: Unpin,
R: AsyncBufRead + Unpin + ?Sized, type Output = Result<usize, Error>;
Creates a future which will read all the bytes associated with this I/O
object into buf until the delimiter byte or EOF is reached.
This method is the async equivalent to BufRead::read_until. Read more
sourcefn read_line(&'a mut self, buf: &'a mut String) -> ReadLine<'a, Self>ⓘNotable traits for ReadLine<'_, R>impl<'_, R> Future for ReadLine<'_, R> where
R: AsyncBufRead + Unpin + ?Sized, type Output = Result<usize, Error>; where
Self: Unpin,
fn read_line(&'a mut self, buf: &'a mut String) -> ReadLine<'a, Self>ⓘNotable traits for ReadLine<'_, R>impl<'_, R> Future for ReadLine<'_, R> where
R: AsyncBufRead + Unpin + ?Sized, type Output = Result<usize, Error>; where
Self: Unpin,
R: AsyncBufRead + Unpin + ?Sized, type Output = Result<usize, Error>;
Creates a future which will read all the bytes associated with this I/O
object into buf until a newline (the 0xA byte) or EOF is reached,
This method is the async equivalent to BufRead::read_line. Read more
sourcefn lines(self) -> Lines<Self>
fn lines(self) -> Lines<Self>
Returns a stream over the lines of this reader.
This method is the async equivalent to BufRead::lines. Read more
sourceimpl<R> AsyncReadExt for R where
R: AsyncRead + ?Sized,
impl<R> AsyncReadExt for R where
R: AsyncRead + ?Sized,
sourcefn chain<R>(self, next: R) -> Chain<Self, R> where
R: AsyncRead,
fn chain<R>(self, next: R) -> Chain<Self, R> where
R: AsyncRead,
Creates an adaptor which will chain this stream with another. Read more
sourcefn read(&'a mut self, buf: &'a mut [u8]) -> Read<'a, Self>ⓘNotable traits for Read<'_, R>impl<'_, R> Future for Read<'_, R> where
R: AsyncRead + Unpin + ?Sized, type Output = Result<usize, Error>; where
Self: Unpin,
fn read(&'a mut self, buf: &'a mut [u8]) -> Read<'a, Self>ⓘNotable traits for Read<'_, R>impl<'_, R> Future for Read<'_, R> where
R: AsyncRead + Unpin + ?Sized, type Output = Result<usize, Error>; where
Self: Unpin,
R: AsyncRead + Unpin + ?Sized, type Output = Result<usize, Error>;
Tries to read some bytes directly into the given buf in asynchronous
manner, returning a future type. Read more
sourcefn read_vectored(
&'a mut self,
bufs: &'a mut [IoSliceMut<'a>]
) -> ReadVectored<'a, Self>ⓘNotable traits for ReadVectored<'_, R>impl<'_, R> Future for ReadVectored<'_, R> where
R: AsyncRead + Unpin + ?Sized, type Output = Result<usize, Error>; where
Self: Unpin,
fn read_vectored(
&'a mut self,
bufs: &'a mut [IoSliceMut<'a>]
) -> ReadVectored<'a, Self>ⓘNotable traits for ReadVectored<'_, R>impl<'_, R> Future for ReadVectored<'_, R> where
R: AsyncRead + Unpin + ?Sized, type Output = Result<usize, Error>; where
Self: Unpin,
R: AsyncRead + Unpin + ?Sized, type Output = Result<usize, Error>;
Creates a future which will read from the AsyncRead into bufs using vectored
IO operations. Read more
sourcefn read_exact(&'a mut self, buf: &'a mut [u8]) -> ReadExact<'a, Self>ⓘNotable traits for ReadExact<'_, R>impl<'_, R> Future for ReadExact<'_, R> where
R: AsyncRead + Unpin + ?Sized, type Output = Result<(), Error>; where
Self: Unpin,
fn read_exact(&'a mut self, buf: &'a mut [u8]) -> ReadExact<'a, Self>ⓘNotable traits for ReadExact<'_, R>impl<'_, R> Future for ReadExact<'_, R> where
R: AsyncRead + Unpin + ?Sized, type Output = Result<(), Error>; where
Self: Unpin,
R: AsyncRead + Unpin + ?Sized, type Output = Result<(), Error>;
Creates a future which will read exactly enough bytes to fill buf,
returning an error if end of file (EOF) is hit sooner. Read more
sourcefn read_to_end(
&'a mut self,
buf: &'a mut Vec<u8, Global>
) -> ReadToEnd<'a, Self>ⓘNotable traits for ReadToEnd<'_, A>impl<'_, A> Future for ReadToEnd<'_, A> where
A: AsyncRead + Unpin + ?Sized, type Output = Result<usize, Error>; where
Self: Unpin,
fn read_to_end(
&'a mut self,
buf: &'a mut Vec<u8, Global>
) -> ReadToEnd<'a, Self>ⓘNotable traits for ReadToEnd<'_, A>impl<'_, A> Future for ReadToEnd<'_, A> where
A: AsyncRead + Unpin + ?Sized, type Output = Result<usize, Error>; where
Self: Unpin,
A: AsyncRead + Unpin + ?Sized, type Output = Result<usize, Error>;
Creates a future which will read all the bytes from this AsyncRead. Read more
sourcefn read_to_string(&'a mut self, buf: &'a mut String) -> ReadToString<'a, Self>ⓘNotable traits for ReadToString<'_, A>impl<'_, A> Future for ReadToString<'_, A> where
A: AsyncRead + Unpin + ?Sized, type Output = Result<usize, Error>; where
Self: Unpin,
fn read_to_string(&'a mut self, buf: &'a mut String) -> ReadToString<'a, Self>ⓘNotable traits for ReadToString<'_, A>impl<'_, A> Future for ReadToString<'_, A> where
A: AsyncRead + Unpin + ?Sized, type Output = Result<usize, Error>; where
Self: Unpin,
A: AsyncRead + Unpin + ?Sized, type Output = Result<usize, Error>;
Creates a future which will read all the bytes from this AsyncRead. Read more
sourceimpl<R> AsyncReadTestExt for R where
R: AsyncRead,
impl<R> AsyncReadTestExt for R where
R: AsyncRead,
sourcefn assert_unmoved(self) -> AssertUnmoved<Self>ⓘNotable traits for AssertUnmoved<Fut>impl<Fut: Future> Future for AssertUnmoved<Fut> type Output = Fut::Output; where
Self: Sized,
fn assert_unmoved(self) -> AssertUnmoved<Self>ⓘNotable traits for AssertUnmoved<Fut>impl<Fut: Future> Future for AssertUnmoved<Fut> type Output = Fut::Output; where
Self: Sized,
Asserts that the given is not moved after being polled. Read more
sourcefn interleave_pending(self) -> InterleavePending<Self>ⓘNotable traits for InterleavePending<Fut>impl<Fut: Future> Future for InterleavePending<Fut> type Output = Fut::Output; where
Self: Sized,
fn interleave_pending(self) -> InterleavePending<Self>ⓘNotable traits for InterleavePending<Fut>impl<Fut: Future> Future for InterleavePending<Fut> type Output = Fut::Output; where
Self: Sized,
Introduces an extra Poll::Pending
in between each read of the reader. Read more
sourceimpl<W> AsyncWriteExt for W where
W: AsyncWrite + ?Sized,
impl<W> AsyncWriteExt for W where
W: AsyncWrite + ?Sized,
sourcefn flush(&mut self) -> Flush<'_, Self>ⓘNotable traits for Flush<'_, W>impl<'_, W> Future for Flush<'_, W> where
W: AsyncWrite + Unpin + ?Sized, type Output = Result<(), Error>; where
Self: Unpin,
fn flush(&mut self) -> Flush<'_, Self>ⓘNotable traits for Flush<'_, W>impl<'_, W> Future for Flush<'_, W> where
W: AsyncWrite + Unpin + ?Sized, type Output = Result<(), Error>; where
Self: Unpin,
W: AsyncWrite + Unpin + ?Sized, type Output = Result<(), Error>;
Creates a future which will entirely flush this AsyncWrite. Read more
sourcefn close(&mut self) -> Close<'_, Self>ⓘNotable traits for Close<'_, W>impl<'_, W> Future for Close<'_, W> where
W: AsyncWrite + Unpin + ?Sized, type Output = Result<(), Error>; where
Self: Unpin,
fn close(&mut self) -> Close<'_, Self>ⓘNotable traits for Close<'_, W>impl<'_, W> Future for Close<'_, W> where
W: AsyncWrite + Unpin + ?Sized, type Output = Result<(), Error>; where
Self: Unpin,
W: AsyncWrite + Unpin + ?Sized, type Output = Result<(), Error>;
Creates a future which will entirely close this AsyncWrite.
sourcefn write(&'a mut self, buf: &'a [u8]) -> Write<'a, Self>ⓘNotable traits for Write<'_, W>impl<'_, W> Future for Write<'_, W> where
W: AsyncWrite + Unpin + ?Sized, type Output = Result<usize, Error>; where
Self: Unpin,
fn write(&'a mut self, buf: &'a [u8]) -> Write<'a, Self>ⓘNotable traits for Write<'_, W>impl<'_, W> Future for Write<'_, W> where
W: AsyncWrite + Unpin + ?Sized, type Output = Result<usize, Error>; where
Self: Unpin,
W: AsyncWrite + Unpin + ?Sized, type Output = Result<usize, Error>;
Creates a future which will write bytes from buf into the object. Read more
sourcefn write_vectored(
&'a mut self,
bufs: &'a [IoSlice<'a>]
) -> WriteVectored<'a, Self>ⓘNotable traits for WriteVectored<'_, W>impl<'_, W> Future for WriteVectored<'_, W> where
W: AsyncWrite + Unpin + ?Sized, type Output = Result<usize, Error>; where
Self: Unpin,
fn write_vectored(
&'a mut self,
bufs: &'a [IoSlice<'a>]
) -> WriteVectored<'a, Self>ⓘNotable traits for WriteVectored<'_, W>impl<'_, W> Future for WriteVectored<'_, W> where
W: AsyncWrite + Unpin + ?Sized, type Output = Result<usize, Error>; where
Self: Unpin,
W: AsyncWrite + Unpin + ?Sized, type Output = Result<usize, Error>;
Creates a future which will write bytes from bufs into the object using vectored
IO operations. Read more
sourceimpl<W> AsyncWriteTestExt for W where
W: AsyncWrite,
impl<W> AsyncWriteTestExt for W where
W: AsyncWrite,
sourcefn assert_unmoved_write(self) -> AssertUnmoved<Self>ⓘNotable traits for AssertUnmoved<Fut>impl<Fut: Future> Future for AssertUnmoved<Fut> type Output = Fut::Output; where
Self: Sized,
fn assert_unmoved_write(self) -> AssertUnmoved<Self>ⓘNotable traits for AssertUnmoved<Fut>impl<Fut: Future> Future for AssertUnmoved<Fut> type Output = Fut::Output; where
Self: Sized,
Asserts that the given is not moved after being polled. Read more
sourcefn interleave_pending_write(self) -> InterleavePending<Self>ⓘNotable traits for InterleavePending<Fut>impl<Fut: Future> Future for InterleavePending<Fut> type Output = Fut::Output; where
Self: Sized,
fn interleave_pending_write(self) -> InterleavePending<Self>ⓘNotable traits for InterleavePending<Fut>impl<Fut: Future> Future for InterleavePending<Fut> type Output = Fut::Output; where
Self: Sized,
Introduces an extra Poll::Pending
in between each operation on the writer. Read more
sourcefn limited_write(self, limit: usize) -> Limited<Self> where
Self: Sized,
fn limited_write(self, limit: usize) -> Limited<Self> where
Self: Sized,
Limit the number of bytes allowed to be written on each call to poll_write. Read more
sourcefn track_closed(self) -> TrackClosed<Self> where
Self: Sized,
fn track_closed(self) -> TrackClosed<Self> where
Self: Sized,
Track whether this stream has been closed and errors if it is used after closing. Read more
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more