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]
impl<R> Take<R>
[src]pub fn limit(&self) -> u64
[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]
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]
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]
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]
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]
impl<R: AsyncBufRead> AsyncBufRead for Take<R>
[src]impl<R: AsyncRead> AsyncRead for Take<R>
[src]
impl<R: AsyncRead> AsyncRead for Take<R>
[src]impl<'__pin, R> Unpin for Take<R> where
__Origin<'__pin, R>: Unpin,
[src]
__Origin<'__pin, R>: Unpin,
Auto Trait Implementations
impl<R> RefUnwindSafe for Take<R> where
R: RefUnwindSafe,
R: RefUnwindSafe,
impl<R> Send for Take<R> where
R: Send,
R: Send,
impl<R> Sync for Take<R> where
R: Sync,
R: Sync,
impl<R> UnwindSafe for Take<R> where
R: UnwindSafe,
R: UnwindSafe,
Blanket Implementations
impl<R> AsyncBufReadExt for R where
R: AsyncBufRead + ?Sized,
[src]
impl<R> AsyncBufReadExt for R where
R: AsyncBufRead + ?Sized,
[src]fn fill_buf(&mut self) -> FillBuf<'_, Self>ⓘ where
Self: Unpin,
[src]
fn fill_buf(&mut self) -> FillBuf<'_, Self>ⓘ where
Self: Unpin,
[src]Returns the contents of the internal buffer, filling it with more data if empty. 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]
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]
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
impl<R> AsyncReadExt for R where
R: AsyncRead + ?Sized,
[src]
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]
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]
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]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]
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]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]
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]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]
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]
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
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more