Struct futures_util::io::Chain[−][src]

#[must_use = "readers do nothing unless polled"]
pub struct Chain<T, U> { /* fields omitted */ }
This is supported on crate feature io only.
Expand description

Reader for the chain method.

Implementations

impl<T, U> Chain<T, U> where
    T: AsyncRead,
    U: AsyncRead, [src]

pub fn get_ref(&self) -> (&T, &U)[src]

Gets references to the underlying readers in this Chain.

pub fn get_mut(&mut self) -> (&mut T, &mut U)[src]

Gets mutable references to the underlying readers in this Chain.

Care should be taken to avoid modifying the internal I/O state of the underlying readers as doing so may corrupt the internal state of this Chain.

pub fn get_pin_mut(self: Pin<&mut Self>) -> (Pin<&mut T>, Pin<&mut U>)[src]

Gets pinned mutable references to the underlying readers in this Chain.

Care should be taken to avoid modifying the internal I/O state of the underlying readers as doing so may corrupt the internal state of this Chain.

pub fn into_inner(self) -> (T, U)[src]

Consumes the Chain, returning the wrapped readers.

Trait Implementations

impl<T, U> AsyncBufRead for Chain<T, U> where
    T: AsyncBufRead,
    U: AsyncBufRead, [src]

fn poll_fill_buf(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>
) -> Poll<Result<&[u8]>>[src]

Attempt to return the contents of the internal buffer, filling it with more data from the inner reader if it is empty. Read more

fn consume(self: Pin<&mut Self>, amt: usize)[src]

Tells this buffer that amt bytes have been consumed from the buffer, so they should no longer be returned in calls to poll_read. Read more

impl<T, U> AsyncRead for Chain<T, U> where
    T: AsyncRead,
    U: AsyncRead, [src]

fn poll_read(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>,
    buf: &mut [u8]
) -> Poll<Result<usize>>[src]

Attempt to read from the AsyncRead into buf. Read more

fn poll_read_vectored(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>,
    bufs: &mut [IoSliceMut<'_>]
) -> Poll<Result<usize>>[src]

Attempt to read from the AsyncRead into bufs using vectored IO operations. Read more

unsafe fn initializer(&self) -> Initializer[src]

Determines if this AsyncReader can work with buffers of uninitialized memory. Read more

impl<T, U> Debug for Chain<T, U> where
    T: Debug,
    U: Debug, [src]

fn fmt(&self, f: &mut Formatter<'_>) -> Result[src]

Formats the value using the given formatter. Read more

impl<'__pin, T, U> Unpin for Chain<T, U> where
    __Origin<'__pin, T, U>: Unpin, [src]

Auto Trait Implementations

impl<T, U> RefUnwindSafe for Chain<T, U> where
    T: RefUnwindSafe,
    U: RefUnwindSafe, 

impl<T, U> Send for Chain<T, U> where
    T: Send,
    U: Send, 

impl<T, U> Sync for Chain<T, U> where
    T: Sync,
    U: Sync, 

impl<T, U> UnwindSafe for Chain<T, U> where
    T: UnwindSafe,
    U: UnwindSafe, 

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized, [src]

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

impl<R> AsyncBufReadExt for R where
    R: AsyncBufRead + ?Sized, [src]

fn fill_buf(&mut self) -> FillBuf<'_, Self>ⓘ

Notable traits for FillBuf<'a, R>

impl<'a, R: ?Sized> Future for FillBuf<'a, R> where
    R: AsyncBufRead + Unpin,  type Output = Result<&'a [u8]>;
 where
    Self: Unpin, [src]

This is supported on crate feature io only.

Creates a future which will wait for a non-empty buffer to be available from this I/O object or EOF to be reached. Read more

fn consume_unpin(&mut self, amt: usize) where
    Self: Unpin, [src]

This is supported on crate feature io only.

A convenience for calling AsyncBufRead::consume on Unpin IO types. Read more

fn read_until<'a>(
    &'a mut self,
    byte: u8,
    buf: &'a mut Vec<u8>
) -> ReadUntil<'a, Self>ⓘ

Notable traits for ReadUntil<'_, R>

impl<R: AsyncBufRead + ?Sized + Unpin> Future for ReadUntil<'_, R> type Output = Result<usize>;
 where
    Self: Unpin, [src]

This is supported on crate feature io only.

Creates a future which will read all the bytes associated with this I/O object into buf until the delimiter byte or EOF is reached. This method is the async equivalent to BufRead::read_until. Read more

fn read_line<'a>(&'a mut self, buf: &'a mut String) -> ReadLine<'a, Self>ⓘ

Notable traits for ReadLine<'_, R>

impl<R: AsyncBufRead + ?Sized + Unpin> Future for ReadLine<'_, R> type Output = Result<usize>;
 where
    Self: Unpin, [src]

This is supported on crate feature io only.

Creates a future which will read all the bytes associated with this I/O object into buf until a newline (the 0xA byte) or EOF is reached, This method is the async equivalent to BufRead::read_line. Read more

fn lines(self) -> Lines<Self> where
    Self: Sized, [src]

This is supported on crate feature io only.

Returns a stream over the lines of this reader. This method is the async equivalent to BufRead::lines. Read more

impl<R> AsyncReadExt for R where
    R: AsyncRead + ?Sized, [src]

fn chain<R>(self, next: R) -> Chain<Self, R> where
    Self: Sized,
    R: AsyncRead, [src]

This is supported on crate feature io only.

Creates an adaptor which will chain this stream with another. Read more

fn read<'a>(&'a mut self, buf: &'a mut [u8]) -> Read<'a, Self>ⓘ

Notable traits for Read<'_, R>

impl<R: AsyncRead + ?Sized + Unpin> Future for Read<'_, R> type Output = Result<usize>;
 where
    Self: Unpin, [src]

This is supported on crate feature io only.

Tries to read some bytes directly into the given buf in asynchronous manner, returning a future type. Read more

fn read_vectored<'a>(
    &'a mut self,
    bufs: &'a mut [IoSliceMut<'a>]
) -> ReadVectored<'a, Self>ⓘ

Notable traits for ReadVectored<'_, R>

impl<R: AsyncRead + ?Sized + Unpin> Future for ReadVectored<'_, R> type Output = Result<usize>;
 where
    Self: Unpin, [src]

This is supported on crate feature io only.

Creates a future which will read from the AsyncRead into bufs using vectored IO operations. Read more

fn read_exact<'a>(&'a mut self, buf: &'a mut [u8]) -> ReadExact<'a, Self>ⓘ

Notable traits for ReadExact<'_, R>

impl<R: AsyncRead + ?Sized + Unpin> Future for ReadExact<'_, R> type Output = Result<()>;
 where
    Self: Unpin, [src]

This is supported on crate feature io only.

Creates a future which will read exactly enough bytes to fill buf, returning an error if end of file (EOF) is hit sooner. Read more

fn read_to_end<'a>(&'a mut self, buf: &'a mut Vec<u8>) -> ReadToEnd<'a, Self>ⓘ

Notable traits for ReadToEnd<'_, A>

impl<A: ?Sized> Future for ReadToEnd<'_, A> where
    A: AsyncRead + Unpin,  type Output = Result<usize>;
 where
    Self: Unpin, [src]

This is supported on crate feature io only.

Creates a future which will read all the bytes from this AsyncRead. Read more

fn read_to_string<'a>(
    &'a mut self,
    buf: &'a mut String
) -> ReadToString<'a, Self>ⓘ

Notable traits for ReadToString<'_, A>

impl<A: ?Sized> Future for ReadToString<'_, A> where
    A: AsyncRead + Unpin,  type Output = Result<usize>;
 where
    Self: Unpin, [src]

This is supported on crate feature io only.

Creates a future which will read all the bytes from this AsyncRead. Read more

fn split(self) -> (ReadHalf<Self>, WriteHalf<Self>) where
    Self: AsyncWrite + Sized, [src]

This is supported on crate feature io only.

Helper method for splitting this read/write object into two halves. Read more

fn take(self, limit: u64) -> Take<Self> where
    Self: Sized, [src]

This is supported on crate feature io only.

Creates an AsyncRead adapter which will read at most limit bytes from the underlying reader. Read more

fn compat(self) -> Compat<Self>ⓘ

Notable traits for Compat<R>

impl<R: AsyncRead03 + Unpin> Read for Compat<R>impl<W: AsyncWrite03 + Unpin> Write for Compat<W>
 where
    Self: Sized + Unpin, [src]

This is supported on crate features io and io-compat only.

Wraps an AsyncRead in a compatibility wrapper that allows it to be used as a futures 0.1 / tokio-io 0.1 AsyncRead. If the wrapped type implements AsyncWrite as well, the result will also implement the futures 0.1 / tokio 0.1 AsyncWrite trait. Read more

impl<T> Borrow<T> for T where
    T: ?Sized, [src]

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
    T: ?Sized, [src]

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<T, U> Into<U> for T where
    U: From<T>, [src]

pub fn into(self) -> U[src]

Performs the conversion.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, [src]

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]

Performs the conversion.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, [src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]

Performs the conversion.