Struct futures_lite::io::Take[−][src]

pub struct Take<R> { /* fields omitted */ }
Expand description

Reader for the AsyncReadExt::take() method.

Implementations

impl<R> Take<R>[src]

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

Returns the number of bytes before this adapter will return EOF.

Note that EOF may be reached sooner if the underlying reader is shorter than the limit.

Examples

use futures_lite::io::{AsyncReadExt, Cursor};

let reader = Cursor::new("hello");

let reader = reader.take(3);
assert_eq!(reader.limit(), 3);

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

Puts a limit on the number of bytes.

Changing the limit is equivalent to creating a new adapter with AsyncReadExt::take().

Examples

use futures_lite::io::{AsyncReadExt, Cursor};

let reader = Cursor::new("hello");

let mut reader = reader.take(10);
assert_eq!(reader.limit(), 10);

reader.set_limit(3);
assert_eq!(reader.limit(), 3);

pub fn get_ref(&self) -> &R[src]

Gets a reference to the underlying reader.

Examples

use futures_lite::io::{AsyncReadExt, Cursor};

let reader = Cursor::new("hello");

let reader = reader.take(3);
let r = reader.get_ref();

pub fn get_mut(&mut self) -> &mut R[src]

Gets a mutable reference to the underlying reader.

Examples

use futures_lite::io::{AsyncReadExt, Cursor};

let reader = Cursor::new("hello");

let mut reader = reader.take(3);
let r = reader.get_mut();

pub fn into_inner(self) -> R[src]

Unwraps the adapter, returning the underlying reader.

Examples

use futures_lite::io::{AsyncReadExt, Cursor};

let reader = Cursor::new("hello");

let reader = reader.take(3);
let reader = reader.into_inner();

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]

Attempt 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 [u8]
) -> Poll<Result<usize>>[src]

Attempt to read from the AsyncRead into buf. Read more

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

Attempt to read from the AsyncRead into bufs using vectored IO operations. 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, 

impl<R> Send for Take<R> where
    R: Send, 

impl<R> Sync for Take<R> where
    R: Sync, 

impl<R> UnwindSafe for Take<R> where
    R: UnwindSafe, 

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<R> AsyncBufReadExt for R where
    R: AsyncBufRead + ?Sized, [src]

fn fill_buf(&mut self) -> FillBuf<'_, Self>ⓘ

Notable traits for FillBuf<'a, R>

impl<'a, R: ?Sized> Future for FillBuf<'a, R> where
    R: AsyncBufRead + Unpin,  type Output = Result<&'a [u8]>;
 where
    Self: Unpin, [src]

Returns the contents of the internal buffer, filling it with more data if empty. Read more

fn consume(&mut self, amt: usize) where
    Self: Unpin, [src]

Consumes amt buffered bytes. Read more

fn read_until<'a>(
    &'a mut self,
    byte: u8,
    buf: &'a mut Vec<u8>
) -> ReadUntilFuture<'_, Self>ⓘ

Notable traits for ReadUntilFuture<'_, R>

impl<R: AsyncBufRead + Unpin + ?Sized> Future for ReadUntilFuture<'_, R> type Output = Result<usize>;
 where
    Self: Unpin, [src]

Reads all bytes and appends them into buf until the delimiter byte or EOF is found. Read more

fn read_line<'a>(&'a mut self, buf: &'a mut String) -> ReadLineFuture<'_, Self>ⓘ

Notable traits for ReadLineFuture<'_, R>

impl<R: AsyncBufRead + Unpin + ?Sized> Future for ReadLineFuture<'_, R> type Output = Result<usize>;
 where
    Self: Unpin, [src]

Reads all bytes and appends them into buf until a newline (the 0xA byte) or EOF is found. Read more

fn lines(self) -> Lines<Self> where
    Self: Unpin + Sized, [src]

Returns a stream over the lines of this byte stream. Read more

fn split(self, byte: u8) -> Split<Self> where
    Self: Sized, [src]

Returns a stream over the contents of this reader split on the specified byte. Read more

impl<R> AsyncReadExt for R where
    R: AsyncRead + ?Sized, [src]

fn read<'a>(&'a mut self, buf: &'a mut [u8]) -> ReadFuture<'a, Self>ⓘ

Notable traits for ReadFuture<'_, R>

impl<R: AsyncRead + Unpin + ?Sized> Future for ReadFuture<'_, R> type Output = Result<usize>;
 where
    Self: Unpin, [src]

Reads some bytes from the byte stream. Read more

fn read_vectored<'a>(
    &'a mut self,
    bufs: &'a mut [IoSliceMut<'a>]
) -> ReadVectoredFuture<'a, Self>ⓘ

Notable traits for ReadVectoredFuture<'_, R>

impl<R: AsyncRead + Unpin + ?Sized> Future for ReadVectoredFuture<'_, R> type Output = Result<usize>;
 where
    Self: Unpin, [src]

Like read(), except it reads into a slice of buffers. Read more

fn read_to_end<'a>(
    &'a mut self,
    buf: &'a mut Vec<u8>
) -> ReadToEndFuture<'a, Self>ⓘ

Notable traits for ReadToEndFuture<'_, R>

impl<R: AsyncRead + Unpin + ?Sized> Future for ReadToEndFuture<'_, R> type Output = Result<usize>;
 where
    Self: Unpin, [src]

Reads the entire contents and appends them to a Vec. Read more

fn read_to_string<'a>(
    &'a mut self,
    buf: &'a mut String
) -> ReadToStringFuture<'a, Self>ⓘ

Notable traits for ReadToStringFuture<'_, R>

impl<R: AsyncRead + Unpin + ?Sized> Future for ReadToStringFuture<'_, R> type Output = Result<usize>;
 where
    Self: Unpin, [src]

Reads the entire contents and appends them to a String. Read more

fn read_exact<'a>(&'a mut self, buf: &'a mut [u8]) -> ReadExactFuture<'a, Self>ⓘ

Notable traits for ReadExactFuture<'_, R>

impl<R: AsyncRead + Unpin + ?Sized> Future for ReadExactFuture<'_, R> type Output = Result<()>;
 where
    Self: Unpin, [src]

Reads the exact number of bytes required to fill buf. Read more

fn take(self, limit: u64) -> Take<Self> where
    Self: Sized, [src]

Creates an adapter which will read at most limit bytes from it. Read more

fn bytes(self) -> Bytes<Self> where
    Self: Sized, [src]

Converts this AsyncRead into a Stream of bytes. Read more

fn chain<R: AsyncRead>(self, next: R) -> Chain<Self, R> where
    Self: Sized, [src]

Creates an adapter which will chain this stream with another. Read more

fn boxed_reader<'a>(self) -> Pin<Box<dyn AsyncRead + Send + 'a>> where
    Self: Sized + Send + 'a, [src]

Boxes the reader and changes its type to dyn AsyncRead + Send + 'a. Read more

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

pub fn borrow(&self) -> &T[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[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.