[−][src]Struct async_std::io::Take
Reader adaptor which limits the bytes read from an underlying reader.
This struct is generally created by calling take
on a reader.
Please see the documentation of take
for more details.
Implementations
impl<T> Take<T>
[src]
pub fn limit(&self) -> u64
[src]
Returns the 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 Read
instance reaches EOF.
Examples
use async_std::prelude::*; use async_std::fs::File; let f = File::open("foo.txt").await?; // read at most five bytes let handle = f.take(5); println!("limit: {}", handle.limit());
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 async_std::prelude::*; use async_std::fs::File; let f = File::open("foo.txt").await?; // read at most five bytes let mut handle = f.take(5); handle.set_limit(10); assert_eq!(handle.limit(), 10);
pub fn into_inner(self) -> T
[src]
Consumes the Take
, returning the wrapped reader.
Examples
use async_std::prelude::*; use async_std::fs::File; let file = File::open("foo.txt").await?; let mut buffer = [0; 5]; let mut handle = file.take(5); handle.read(&mut buffer).await?; let file = handle.into_inner();
pub fn get_ref(&self) -> &T
[src]
Gets a reference to the underlying reader.
Examples
use async_std::prelude::*; use async_std::fs::File; let file = File::open("foo.txt").await?; let mut buffer = [0; 5]; let mut handle = file.take(5); handle.read(&mut buffer).await?; let file = handle.get_ref();
pub fn get_mut(&mut self) -> &mut T
[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 async_std::prelude::*; use async_std::fs::File; let file = File::open("foo.txt").await?; let mut buffer = [0; 5]; let mut handle = file.take(5); handle.read(&mut buffer).await?; let file = handle.get_mut();
Trait Implementations
impl<T: BufRead> BufRead for Take<T>
[src]
pub fn poll_fill_buf(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Result<&[u8]>>
[src]
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Result<&[u8]>>
pub fn consume(self: Pin<&mut Self>, amt: usize)
[src]
pub fn read_until<'a>(
&'a mut self,
byte: u8,
buf: &'a mut Vec<u8>
) -> ImplFuture<usize> where
Self: Unpin,
[src]
&'a mut self,
byte: u8,
buf: &'a mut Vec<u8>
) -> ImplFuture<usize> where
Self: Unpin,
pub fn read_line<'a>(
&'a mut self,
buf: &'a mut String
) -> ImplFuture<Result<usize>> where
Self: Unpin,
[src]
&'a mut self,
buf: &'a mut String
) -> ImplFuture<Result<usize>> where
Self: Unpin,
pub fn lines(self) -> Lines<Self> where
Self: Unpin + Sized,
[src]
Self: Unpin + Sized,
pub fn split(self, byte: u8) -> Split<Self> where
Self: Sized,
[src]
Self: Sized,
impl<T: Debug> Debug for Take<T>
[src]
impl<T: Read> Read for Take<T>
[src]
pub fn poll_read(
self: Pin<&mut Self>,
cx: &mut Context<'_>,
buf: &mut [u8]
) -> Poll<Result<usize>>
[src]
self: Pin<&mut Self>,
cx: &mut Context<'_>,
buf: &mut [u8]
) -> Poll<Result<usize>>
Attempt to read from the AsyncRead
into buf
.
pub fn poll_read_vectored(
self: Pin<&mut Self>,
cx: &mut Context<'_>,
bufs: &mut [IoSliceMut<'_>]
) -> Poll<Result<usize>>
[src]
self: Pin<&mut Self>,
cx: &mut Context<'_>,
bufs: &mut [IoSliceMut<'_>]
) -> Poll<Result<usize>>
pub fn read<'a>(&'a mut self, buf: &'a mut [u8]) -> ImplFuture<Result<usize>> where
Self: Unpin,
[src]
Self: Unpin,
pub fn read_vectored<'a>(
&'a mut self,
bufs: &'a mut [IoSliceMut<'a>]
) -> ImplFuture<Result<usize>> where
Self: Unpin,
[src]
&'a mut self,
bufs: &'a mut [IoSliceMut<'a>]
) -> ImplFuture<Result<usize>> where
Self: Unpin,
pub fn read_to_end<'a>(
&'a mut self,
buf: &'a mut Vec<u8>
) -> ImplFuture<Result<usize>> where
Self: Unpin,
[src]
&'a mut self,
buf: &'a mut Vec<u8>
) -> ImplFuture<Result<usize>> where
Self: Unpin,
pub fn read_to_string<'a>(
&'a mut self,
buf: &'a mut String
) -> ImplFuture<Result<usize>> where
Self: Unpin,
[src]
&'a mut self,
buf: &'a mut String
) -> ImplFuture<Result<usize>> where
Self: Unpin,
pub fn read_exact<'a>(&'a mut self, buf: &'a mut [u8]) -> ImplFuture<Result<()>> where
Self: Unpin,
[src]
Self: Unpin,
pub fn take(self, limit: u64) -> Take<Self> where
Self: Sized,
[src]
Self: Sized,
pub fn by_ref(&mut self) -> &mut Self where
Self: Sized,
[src]
Self: Sized,
pub fn bytes(self) -> Bytes<Self> where
Self: Sized,
[src]
Self: Sized,
pub fn chain<R: Read>(self, next: R) -> Chain<Self, R> where
Self: Sized,
[src]
Self: Sized,
impl<'__pin, T> Unpin for Take<T> where
__Origin<'__pin, T>: Unpin,
[src]
__Origin<'__pin, T>: Unpin,
Auto Trait Implementations
impl<T> RefUnwindSafe for Take<T> where
T: RefUnwindSafe,
[src]
T: RefUnwindSafe,
impl<T> Send for Take<T> where
T: Send,
[src]
T: Send,
impl<T> Sync for Take<T> where
T: Sync,
[src]
T: Sync,
impl<T> UnwindSafe for Take<T> where
T: UnwindSafe,
[src]
T: UnwindSafe,
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
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.
pub 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>,