Struct tokio::io::Take

#[must_use = "streams do nothing unless you `.await` or poll them"]
pub struct Take<R> { /* fields omitted */ }

This is supported on feature="io-util" only.

Stream for the take method.

Methods

impl<R: AsyncRead> Take<R>

pub fn limit(&self) -> u64

This is supported on feature="io-util" and feature="io-util" only.

Returns the remaining number of bytes that can be read before this instance will return EOF.

Note

This instance may reach EOF after reading fewer bytes than indicated by this method if the underlying AsyncRead instance reaches EOF.

pub fn set_limit(&mut self, limit: u64)

This is supported on feature="io-util" and feature="io-util" only.

Sets the number of bytes that can be read before this instance will return EOF. This is the same as constructing a new Take instance, so the amount of bytes read and the previous limit value don't matter when calling this method.

pub fn get_ref(&self) -> &R

This is supported on feature="io-util" and feature="io-util" only.

Gets a reference to the underlying reader.

pub fn get_mut(&mut self) -> &mut R

This is supported on feature="io-util" and feature="io-util" only.

Gets a mutable reference to the underlying reader.

Care should be taken to avoid modifying the internal I/O state of the underlying reader as doing so may corrupt the internal limit of this Take.

pub fn get_pin_mut(self: Pin<&mut Self>) -> Pin<&mut R>

This is supported on feature="io-util" and feature="io-util" only.

Gets a pinned mutable reference to the underlying reader.

Care should be taken to avoid modifying the internal I/O state of the underlying reader as doing so may corrupt the internal limit of this Take.

pub fn into_inner(self) -> R

This is supported on feature="io-util" and feature="io-util" only.

Consumes the Take, returning the wrapped reader.

Trait Implementations

impl<R: AsyncBufRead> AsyncBufRead for Take<R>

fn poll_fill_buf(self: Pin<&mut Self>, cx: &mut Context) -> Poll<Result<&[u8]>>

Attempt to return the contents of the internal buffer, filling it with more data from the inner reader if it is empty.

fn consume(self: Pin<&mut Self>, amt: usize)

Tells this buffer that amt bytes have been consumed from the buffer, so they should no longer be returned in calls to [poll_read].

impl<R: AsyncRead> AsyncRead for Take<R>

unsafe fn prepare_uninitialized_buffer(
    &self,
    buf: &mut [MaybeUninit<u8>]
) -> bool

Prepares an uninitialized buffer to be safe to pass to read. Returns true if the supplied buffer was zeroed out.

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

Attempt to read from the AsyncRead into buf.

fn poll_read_buf<B: BufMut>(
    self: Pin<&mut Self>,
    cx: &mut Context,
    buf: &mut B
) -> Poll<Result<usize>> where
    Self: Sized, 

Pull some bytes from this source into the specified BufMut, returning how many bytes were read.

impl<'__pin, R> Unpin for Take<R> where
    __Origin<'__pin, R>: Unpin, 

impl<R: Debug> Debug for Take<R>

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

Formats the value using the given formatter.