Skip to main content

Chain

Struct Chain 

Source
pub struct Chain<T, U> { /* private fields */ }
Available on crate feature std only.
Expand description

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.

Implementations§

Source§

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

Source

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();
Source

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();
Source

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§

Source§

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

Source§

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

Available on crate feature docs only.
Returns the contents of the internal buffer, filling it with more data from the inner reader if it is empty. Read more
Source§

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

Available on crate feature docs only.
Tells this buffer that amt bytes have been consumed from the buffer, so they should no longer be returned in calls to read.
Source§

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

Available on crate feature docs only.
Reads all bytes into buf until the delimiter byte or EOF is reached. Read more
Source§

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

Available on crate feature docs only.
Reads all bytes and appends them into buf until a newline (the 0xA byte) is reached. Read more
Source§

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

Available on crate feature docs only.
Returns a stream over the lines of this byte stream. Read more
Source§

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

Available on crate feature docs only.
Returns a stream over the contents of this reader split on the byte byte. Read more
Source§

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

Source§

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

Formats the value using the given formatter. Read more
Source§

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

Source§

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

Available on crate feature docs only.
Attempt to read from the AsyncRead into buf.
Source§

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

Available on crate feature docs only.
Attempt to read from the AsyncRead into bufs using vectored IO operations.
Source§

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

Available on crate feature docs only.
Reads some bytes from the byte stream. Read more
Source§

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

Available on crate feature docs only.
Like read, except that it reads into a slice of buffers. Read more
Source§

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

Available on crate feature docs only.
Reads all bytes from the byte stream. Read more
Source§

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

Available on crate feature docs only.
Reads all bytes from the byte stream and appends them into a string. Read more
Source§

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

Available on crate feature docs only.
Reads the exact number of bytes required to fill buf. Read more
Source§

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

Available on crate feature docs only.
Creates an adaptor which will read at most limit bytes from it. Read more
Source§

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

Available on crate feature docs only.
Creates a “by reference” adaptor for this instance of Read. Read more
Source§

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

Available on crate feature docs only.
Transforms this Read instance to a Stream over its bytes. Read more
Source§

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

Available on crate feature docs only.
Creates an adaptor which will chain this stream with another. Read more
Source§

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

Auto Trait Implementations§

§

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

§

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

§

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> UnsafeUnpin for Chain<T, U>
where T: UnsafeUnpin, U: UnsafeUnpin,

§

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

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> BufReadExt for T
where T: BufRead + ?Sized,

Source§

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

Available on crate feature std only.
Reads all bytes into buf until the delimiter byte or EOF is reached. Read more
Source§

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

Available on crate feature std only.
Reads all bytes and appends them into buf until a newline (the 0xA byte) is reached. Read more
Source§

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

Available on crate feature std only.
Returns a stream over the lines of this byte stream. Read more
Source§

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

Available on crate feature std only.
Returns a stream over the contents of this reader split on the byte byte. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ReadExt for T
where T: Read + ?Sized,

Source§

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

Available on crate feature std only.
Reads some bytes from the byte stream. Read more
Source§

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

Available on crate feature std only.
Like read, except that it reads into a slice of buffers. Read more
Source§

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

Available on crate feature std only.
Reads all bytes from the byte stream. Read more
Source§

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

Available on crate feature std only.
Reads all bytes from the byte stream and appends them into a string. Read more
Source§

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

Available on crate feature std only.
Reads the exact number of bytes required to fill buf. Read more
Source§

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

Available on crate feature std only.
Creates an adaptor which will read at most limit bytes from it. Read more
Source§

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

Available on crate feature std only.
Creates a “by reference” adaptor for this instance of Read. Read more
Source§

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

Available on crate feature std only.
Transforms this Read instance to a Stream over its bytes. Read more
Source§

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

Available on crate feature std only.
Creates an adaptor which will chain this stream with another. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.