Struct async_std::io::Chain

pub struct Chain<T, U> { /* fields omitted */ }

Adaptor to chain together two readers.

This struct is generally created by calling chain on a reader. Please see the documentation of chain for more details.

Methods

impl<T, U> Chain<T, U>

pub fn into_inner(self) -> (T, U)

Consumes the Chain, returning the wrapped readers.

Examples

use async_std::prelude::*;
use async_std::fs::File;

let foo_file = File::open("foo.txt").await?;
let bar_file = File::open("bar.txt").await?;

let chain = foo_file.chain(bar_file);
let (foo_file, bar_file) = chain.into_inner();

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

Gets references to the underlying readers in this Chain.

Examples

use async_std::prelude::*;
use async_std::fs::File;

let foo_file = File::open("foo.txt").await?;
let bar_file = File::open("bar.txt").await?;

let chain = foo_file.chain(bar_file);
let (foo_file, bar_file) = chain.get_ref();

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

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.

Examples

use async_std::prelude::*;
use async_std::fs::File;

let foo_file = File::open("foo.txt").await?;
let bar_file = File::open("bar.txt").await?;

let mut chain = foo_file.chain(bar_file);
let (foo_file, bar_file) = chain.get_mut();

Trait Implementations

impl<T: BufRead, U: BufRead> BufRead for Chain<T, U>

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

Returns the contents of the internal buffer, filling it with more data from the inner reader if it is empty.

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

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

fn read_until<'a>(
    &'a mut self,
    byte: u8,
    buf: &'a mut Vec<u8>
) -> ImplFuture<usize> where
    Self: Unpin, 

Reads all bytes into buf until the delimiter byte or EOF is reached.

fn read_line<'a>(&'a mut self, buf: &'a mut String) -> ImplFuture<Result<usize>> where
    Self: Unpin, 

Reads all bytes and appends them into buf until a newline (the 0xA byte) is reached.

fn lines(self) -> Lines<Self> where
    Self: Unpin + Sized, 

Returns a stream over the lines of this byte stream.

fn split(self, byte: u8) -> Split<Self> where
    Self: Sized, 

Returns a stream over the contents of this reader split on the byte byte.

impl<T: Debug, U: Debug> Debug for Chain<T, U>

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<T: Read, U: Read> Read for Chain<T, U>

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

Attempt to read from the AsyncRead into buf.

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

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

fn read<'a>(&'a mut self, buf: &'a mut [u8]) -> ImplFuture<Result<usize>> where
    Self: Unpin, 

Reads some bytes from the byte stream.

fn read_vectored<'a>(
    &'a mut self,
    bufs: &'a mut [IoSliceMut<'a>]
) -> ImplFuture<Result<usize>> where
    Self: Unpin, 

Like [read], except that it reads into a slice of buffers.

fn read_to_end<'a>(
    &'a mut self,
    buf: &'a mut Vec<u8>
) -> ImplFuture<Result<usize>> where
    Self: Unpin, 

Reads all bytes from the byte stream.

fn read_to_string<'a>(
    &'a mut self,
    buf: &'a mut String
) -> ImplFuture<Result<usize>> where
    Self: Unpin, 

Reads all bytes from the byte stream and appends them into a string.

fn read_exact<'a>(&'a mut self, buf: &'a mut [u8]) -> ImplFuture<Result<()>> where
    Self: Unpin, 

Reads the exact number of bytes required to fill buf.

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

Creates an adaptor which will read at most limit bytes from it.

fn by_ref(&mut self) -> &mut Self where
    Self: Sized, 

Creates a "by reference" adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self> where
    Self: Sized, 

Transforms this Read instance to a Stream over its bytes.

fn chain<R: Read>(self, next: R) -> Chain<Self, R> where
    Self: Sized, 

Creates an adaptor which will chain this stream with another.

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