# tokio::io::Take - Rust
API documentation for the Rust `Take` struct in crate `tokio`.
Keywords: rust, rustlang, rust-lang, Take

# Struct tokio::io::Take [−] [src]

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

Stream for the `take` method.

## Implementations

### `impl<R: AsyncRead> Take<R>` [src]

#### `pub fn limit(&self) -> u64` [src]

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)` [src]

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ⓘ

### Notable traits for &'_ mut F

`impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;`
` [src]

Gets a reference to the underlying reader.

#### `pub fn get_mut(&mut self) -> &mut Rⓘ

### Notable traits for &'_ mut F

`impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;`
` [src]

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>ⓘ

### Notable traits for Pin<P>

`impl<P> Future for Pin<P> where
P: Unpin + DerefMut,
<P as Deref>::Target: Future, type Output = <<P as Deref>::Target as Future>::Output;`
` [src]

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` [src]

Consumes the `Take`, returning the wrapped reader.

## Trait Implementations

### `impl<R: AsyncBufRead> AsyncBufRead for Take<R>` [src]

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

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

#### `fn consume(self: Pin<&mut Self>, amt: usize)` [src]

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

### `impl<R: AsyncRead> AsyncRead for Take<R>` [src]

#### `fn poll_read(
self: Pin<&mut Self>,
cx: &mut Context<'_>,
buf: &mut ReadBuf<'_>
) -> Poll<Result<(), Error>>` [src]

Attempts to read from the `AsyncRead` into `buf`. Read more

### `impl<R: Debug> Debug for Take<R>` [src]

#### `fn fmt(&self, f: &mut Formatter<'_>) -> Result` [src]

Formats the value using the given formatter. Read more

### `impl<'__pin, R> Unpin for Take<R> where
__Origin<'__pin, R>: Unpin,` [src]

## Auto Trait Implementations

### `impl<R> RefUnwindSafe for Take<R> where
R: RefUnwindSafe,` [src]

### `impl<R> Send for Take<R> where
R: Send,` [src]

### `impl<R> Sync for Take<R> where
R: Sync,` [src]

### `impl<R> UnwindSafe for Take<R> where
R: UnwindSafe,` [src]

## Blanket Implementations

### `impl<T> Any for T where
T: 'static + ?Sized,` [src]

#### `pub fn type_id(&self) -> TypeId` [src]

Gets the `TypeId` of `self`. Read more

### `impl<T> Borrow<T> for T where
T: ?Sized,` [src]

#### `pub fn borrow(&self) -> &Tⓘ

### Notable traits for &'_ mut F

`impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;`
` [src]

Immutably borrows from an owned value. Read more

### `impl<T> BorrowMut<T> for T where
T: ?Sized,` [src]

#### `pub fn borrow_mut(&mut self) -> &mut Tⓘ

### Notable traits for &'_ mut F

`impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;`
` [src]

Mutably borrows from an owned value. Read more

### `impl<T> From<T> for T` [src]

#### `pub fn from(t: T) -> T` [src]

Performs the conversion.

### `impl<T, U> Into<U> for T where
U: From<T>,` [src]

#### `pub fn into(self) -> U` [src]

Performs the conversion.

### `impl<T, U> TryFrom<U> for T where
U: Into<T>,` [src]

#### `type Error = Infallible`

The type returned in the event of a conversion error.

#### `pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>` [src]

Performs the conversion.

### `impl<T, U> TryInto<U> for T where
U: TryFrom<T>,` [src]

#### `type Error = <U as TryFrom<T>>::Error`

The type returned in the event of a conversion error.

#### `pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>` [src]

Performs the conversion.