[−][src]Struct futures::io::Take
Reader for the take
method.
Methods
impl<R> Take<R> where
R: AsyncRead,
[src]
R: AsyncRead,
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.
Examples
use futures::io::AsyncReadExt; use std::io::Cursor; let reader = Cursor::new(&b"12345678"[..]); let mut buffer = [0; 2]; let mut take = reader.take(4); let n = take.read(&mut buffer).await?; assert_eq!(take.limit(), 2);
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.
Examples
use futures::io::AsyncReadExt; use std::io::Cursor; let reader = Cursor::new(&b"12345678"[..]); let mut buffer = [0; 4]; let mut take = reader.take(4); let n = take.read(&mut buffer).await?; assert_eq!(n, 4); assert_eq!(take.limit(), 0); take.set_limit(10); let n = take.read(&mut buffer).await?; assert_eq!(n, 4);
ⓘImportant traits for &'_ mut Fpub fn get_ref(&self) -> &R
[src]
Gets a reference to the underlying reader.
Examples
use futures::io::AsyncReadExt; use std::io::Cursor; let reader = Cursor::new(&b"12345678"[..]); let mut buffer = [0; 4]; let mut take = reader.take(4); let n = take.read(&mut buffer).await?; let cursor_ref = take.get_ref(); assert_eq!(cursor_ref.position(), 4);
ⓘImportant traits for &'_ mut Fpub fn get_mut(&mut self) -> &mut R
[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
.
Examples
use futures::io::AsyncReadExt; use std::io::Cursor; let reader = Cursor::new(&b"12345678"[..]); let mut buffer = [0; 4]; let mut take = reader.take(4); let n = take.read(&mut buffer).await?; let cursor_mut = take.get_mut();
ⓘImportant traits for Pin<P>pub fn get_pin_mut(self: Pin<&mut Take<R>>) -> Pin<&mut R>
[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.
Examples
use futures::io::AsyncReadExt; use std::io::Cursor; let reader = Cursor::new(&b"12345678"[..]); let mut buffer = [0; 4]; let mut take = reader.take(4); let n = take.read(&mut buffer).await?; let cursor = take.into_inner(); assert_eq!(cursor.position(), 4);
Trait Implementations
impl<R> AsyncBufRead for Take<R> where
R: AsyncBufRead,
[src]
R: AsyncBufRead,
fn poll_fill_buf(
self: Pin<&mut Take<R>>,
cx: &mut Context
) -> Poll<Result<&[u8], Error>>
[src]
self: Pin<&mut Take<R>>,
cx: &mut Context
) -> Poll<Result<&[u8], Error>>
fn consume(self: Pin<&mut Take<R>>, amt: usize)
[src]
impl<R> AsyncRead for Take<R> where
R: AsyncRead,
[src]
R: AsyncRead,
fn poll_read(
self: Pin<&mut Take<R>>,
cx: &mut Context,
buf: &mut [u8]
) -> Poll<Result<usize, Error>>
[src]
self: Pin<&mut Take<R>>,
cx: &mut Context,
buf: &mut [u8]
) -> Poll<Result<usize, Error>>
unsafe fn initializer(&self) -> Initializer
[src]
fn poll_read_vectored(
self: Pin<&mut Self>,
cx: &mut Context,
bufs: &mut [IoSliceMut]
) -> Poll<Result<usize, Error>>
[src]
self: Pin<&mut Self>,
cx: &mut Context,
bufs: &mut [IoSliceMut]
) -> Poll<Result<usize, Error>>
impl<R> Unpin for Take<R> where
R: Unpin,
[src]
R: Unpin,
impl<R> Debug for Take<R> where
R: Debug,
[src]
R: Debug,
Auto Trait Implementations
impl<R> Send for Take<R> where
R: Send,
R: Send,
impl<R> Sync for Take<R> where
R: Sync,
R: Sync,
impl<R> RefUnwindSafe for Take<R> where
R: RefUnwindSafe,
R: RefUnwindSafe,
impl<R> UnwindSafe for Take<R> where
R: UnwindSafe,
R: UnwindSafe,
Blanket Implementations
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> From<T> for T
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
ⓘImportant traits for &'_ mut Ffn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<R> AsyncReadExt for R where
R: AsyncRead + ?Sized,
[src]
R: AsyncRead + ?Sized,
fn chain<R>(self, next: R) -> Chain<Self, R> where
R: AsyncRead,
[src]
R: AsyncRead,
ⓘImportant traits for CopyInto<'_, R, W>fn copy_into<W>(self, writer: &mut W) -> CopyInto<Self, W> where
W: AsyncWrite + Unpin + ?Sized,
[src]
W: AsyncWrite + Unpin + ?Sized,
ⓘImportant traits for Read<'_, R>fn read(&'a mut self, buf: &'a mut [u8]) -> Read<'a, Self> where
Self: Unpin,
[src]
Self: Unpin,
ⓘImportant traits for ReadVectored<'_, R>fn read_vectored(
&'a mut self,
bufs: &'a mut [IoSliceMut<'a>]
) -> ReadVectored<'a, Self> where
Self: Unpin,
[src]
&'a mut self,
bufs: &'a mut [IoSliceMut<'a>]
) -> ReadVectored<'a, Self> where
Self: Unpin,
ⓘImportant traits for ReadExact<'_, R>fn read_exact(&'a mut self, buf: &'a mut [u8]) -> ReadExact<'a, Self> where
Self: Unpin,
[src]
Self: Unpin,
ⓘImportant traits for ReadToEnd<'_, A>fn read_to_end(&'a mut self, buf: &'a mut Vec<u8>) -> ReadToEnd<'a, Self> where
Self: Unpin,
[src]
Self: Unpin,
ⓘImportant traits for ReadToString<'_, A>fn read_to_string(&'a mut self, buf: &'a mut String) -> ReadToString<'a, Self> where
Self: Unpin,
[src]
Self: Unpin,
fn split(self) -> (ReadHalf<Self>, WriteHalf<Self>) where
Self: AsyncWrite,
[src]
Self: AsyncWrite,
fn take(self, limit: u64) -> Take<Self>
[src]
ⓘImportant traits for Compat<R>fn compat(self) -> Compat<Self> where
Self: Unpin,
[src]
Self: Unpin,
impl<R> AsyncBufReadExt for R where
R: AsyncBufRead + ?Sized,
[src]
R: AsyncBufRead + ?Sized,
ⓘImportant traits for CopyBufInto<'_, R, W>fn copy_buf_into<W>(self, writer: &mut W) -> CopyBufInto<Self, W> where
W: AsyncWrite + Unpin + ?Sized,
[src]
W: AsyncWrite + Unpin + ?Sized,
ⓘImportant traits for ReadUntil<'_, R>fn read_until(
&'a mut self,
byte: u8,
buf: &'a mut Vec<u8>
) -> ReadUntil<'a, Self> where
Self: Unpin,
[src]
&'a mut self,
byte: u8,
buf: &'a mut Vec<u8>
) -> ReadUntil<'a, Self> where
Self: Unpin,
ⓘImportant traits for ReadLine<'_, R>fn read_line(&'a mut self, buf: &'a mut String) -> ReadLine<'a, Self> where
Self: Unpin,
[src]
Self: Unpin,