Struct futures_lite::io::Take
source · [−]pub struct Take<R> { /* private fields */ }
Expand description
Reader for the AsyncReadExt::take()
method.
Implementations
sourceimpl<R> Take<R>
impl<R> Take<R>
sourcepub fn limit(&self) -> u64
pub fn limit(&self) -> u64
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);
sourcepub fn set_limit(&mut self, limit: u64)
pub fn set_limit(&mut self, limit: u64)
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);
sourcepub fn get_ref(&self) -> &R
pub fn get_ref(&self) -> &R
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();
sourcepub fn get_mut(&mut self) -> &mut R
pub fn get_mut(&mut self) -> &mut R
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();
sourcepub fn into_inner(self) -> R
pub fn into_inner(self) -> R
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
sourceimpl<R: AsyncBufRead> AsyncBufRead for Take<R>
impl<R: AsyncBufRead> AsyncBufRead for Take<R>
sourceimpl<R: AsyncRead> AsyncRead for Take<R>
impl<R: AsyncRead> AsyncRead for Take<R>
impl<'__pin, R> Unpin for Take<R> where
__Origin<'__pin, R>: Unpin,
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
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]>;
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]>;
where
Self: Unpin,
R: AsyncBufRead + Unpin + ?Sized, type Output = Result<&'a [u8]>;
Returns the contents of the internal buffer, filling it with more data if empty. Read more
sourcefn 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,
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,
Reads all bytes and appends them into buf
until the delimiter byte
or EOF is found. Read more
sourcefn 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,
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,
Reads all bytes and appends them into buf
until a newline (the 0xA byte) or EOF is found. Read more
sourceimpl<R> AsyncReadExt for R where
R: AsyncRead + ?Sized,
impl<R> AsyncReadExt for R where
R: AsyncRead + ?Sized,
sourcefn 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,
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,
Reads some bytes from the byte stream. Read more
sourcefn 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,
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,
sourcefn 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,
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,
sourcefn 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,
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,
sourcefn 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,
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,
Reads the exact number of bytes required to fill buf
. Read more
sourcefn take(self, limit: u64) -> Take<Self> where
Self: Sized,
fn take(self, limit: u64) -> Take<Self> where
Self: Sized,
Creates an adapter which will read at most limit
bytes from it. 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