[−][src]Struct geng_core::prelude::futures::io::Take
Reader for the take
method.
Implementations
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);
pub fn get_ref(&self) -> &RⓘImportant traits for &'_ mut R
impl<'_, R> Read for &'_ mut R where
R: Read + ?Sized, impl<'_, W> Write for &'_ mut W where
W: Write + ?Sized, impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;
[src]
Important traits for &'_ mut R
impl<'_, R> Read for &'_ mut R where
R: Read + ?Sized, impl<'_, W> Write for &'_ mut W where
W: Write + ?Sized, impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;
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);
pub fn get_mut(&mut self) -> &mut RⓘImportant traits for &'_ mut R
impl<'_, R> Read for &'_ mut R where
R: Read + ?Sized, impl<'_, W> Write for &'_ mut W where
W: Write + ?Sized, impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;
[src]
Important traits for &'_ mut R
impl<'_, R> Read for &'_ mut R where
R: Read + ?Sized, impl<'_, W> Write for &'_ mut W where
W: Write + ?Sized, impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;
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();
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>>
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> Debug for Take<R> where
R: Debug,
[src]
R: Debug,
impl<R> Unpin for Take<R> where
R: Unpin,
[src]
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<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<R> AsyncBufReadExt for R where
R: AsyncBufRead + ?Sized,
[src]
R: AsyncBufRead + ?Sized,
fn copy_buf_into<W>(self, writer: &mut W) -> CopyBufInto<Self, W>ⓘImportant traits for CopyBufInto<'_, R, W>
impl<'_, R, W> Future for CopyBufInto<'_, R, W> where
R: AsyncBufRead,
W: AsyncWrite + Unpin + ?Sized, type Output = Result<u64, Error>;
where
W: AsyncWrite + Unpin + ?Sized,
[src]
Important traits for CopyBufInto<'_, R, W>
impl<'_, R, W> Future for CopyBufInto<'_, R, W> where
R: AsyncBufRead,
W: AsyncWrite + Unpin + ?Sized, type Output = Result<u64, Error>;
W: AsyncWrite + Unpin + ?Sized,
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,
fn read_line(&'a mut self, buf: &'a mut String) -> ReadLine<'a, Self>ⓘ where
Self: Unpin,
[src]
Self: Unpin,
fn lines(self) -> Lines<Self>
[src]
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,
fn copy_into<W>(self, writer: &mut W) -> CopyInto<Self, W>ⓘ where
W: AsyncWrite + Unpin + ?Sized,
[src]
W: AsyncWrite + Unpin + ?Sized,
fn read(&'a mut self, buf: &'a mut [u8]) -> Read<'a, Self>ⓘ where
Self: Unpin,
[src]
Self: Unpin,
fn read_vectored(
&'a mut self,
bufs: &'a mut [IoSliceMut<'a>]
) -> ReadVectored<'a, Self>ⓘImportant traits for ReadVectored<'_, R>
impl<'_, R> Future for ReadVectored<'_, R> where
R: Unpin + AsyncRead + ?Sized, type Output = Result<usize, Error>;
where
Self: Unpin,
[src]
&'a mut self,
bufs: &'a mut [IoSliceMut<'a>]
) -> ReadVectored<'a, Self>ⓘ
Important traits for ReadVectored<'_, R>
impl<'_, R> Future for ReadVectored<'_, R> where
R: Unpin + AsyncRead + ?Sized, type Output = Result<usize, Error>;
Self: Unpin,
fn read_exact(&'a mut self, buf: &'a mut [u8]) -> ReadExact<'a, Self>ⓘ where
Self: Unpin,
[src]
Self: Unpin,
fn read_to_end(&'a mut self, buf: &'a mut Vec<u8>) -> ReadToEnd<'a, Self>ⓘ where
Self: Unpin,
[src]
Self: Unpin,
fn read_to_string(&'a mut self, buf: &'a mut String) -> ReadToString<'a, Self>ⓘImportant traits for ReadToString<'_, A>
impl<'_, A> Future for ReadToString<'_, A> where
A: AsyncRead + Unpin + ?Sized, type Output = Result<usize, Error>;
where
Self: Unpin,
[src]
Important traits for ReadToString<'_, A>
impl<'_, A> Future for ReadToString<'_, A> where
A: AsyncRead + Unpin + ?Sized, type Output = Result<usize, Error>;
Self: Unpin,
fn split(self) -> (ReadHalf<Self>, WriteHalf<Self>) where
Self: AsyncWrite,
[src]
Self: AsyncWrite,
fn take(self, limit: u64) -> Take<Self>
[src]
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow(&self) -> &TⓘImportant traits for &'_ mut R
impl<'_, R> Read for &'_ mut R where
R: Read + ?Sized, impl<'_, W> Write for &'_ mut W where
W: Write + ?Sized, impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;
[src]
Important traits for &'_ mut R
impl<'_, R> Read for &'_ mut R where
R: Read + ?Sized, impl<'_, W> Write for &'_ mut W where
W: Write + ?Sized, impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut TⓘImportant traits for &'_ mut R
impl<'_, R> Read for &'_ mut R where
R: Read + ?Sized, impl<'_, W> Write for &'_ mut W where
W: Write + ?Sized, impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;
[src]
Important traits for &'_ mut R
impl<'_, R> Read for &'_ mut R where
R: Read + ?Sized, impl<'_, W> Write for &'_ mut W where
W: Write + ?Sized, impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> SetParameter for T
fn set<T>(&mut self, value: T) -> <T as Parameter<Self>>::Result where
T: Parameter<Self>,
T: Parameter<Self>,
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<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,