Struct std::io::Chain

[+] Show declaration

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

[−] 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.

Methods

impl<T, U> Chain<T, U>[−]

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

Consumes the Chain, returning the wrapped readers.

Examples

use std::io;
use std::io::prelude::*;
use std::fs::File;

fn main() -> io::Result<()> {
    let mut foo_file = File::open("foo.txt")?;
    let mut bar_file = File::open("bar.txt")?;

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

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

Gets references to the underlying readers in this Chain.

Examples

use std::io;
use std::io::prelude::*;
use std::fs::File;

fn main() -> io::Result<()> {
    let mut foo_file = File::open("foo.txt")?;
    let mut bar_file = File::open("bar.txt")?;

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

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 std::io;
use std::io::prelude::*;
use std::fs::File;

fn main() -> io::Result<()> {
    let mut foo_file = File::open("foo.txt")?;
    let mut bar_file = File::open("bar.txt")?;

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

Trait Implementations

impl<T: Read, U: Read> Read for Chain<T, U>[+]

[+] Show hidden undocumented items

fn read(&mut self, buf: &mut [u8]) -> Result<usize>[−]

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

fn read_vectored(&mut self, bufs: &mut [IoSliceMut]) -> Result<usize>[−]

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

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

🔬 This is a nightly-only experimental API. (read_initializer #42788)

Determines if this Reader can work with buffers of uninitialized memory.

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize>[−]

Read all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize>[−]

Read all bytes until EOF in this source, appending them to buf.

fn read_exact(&mut self, buf: &mut [u8]) -> Result<()>[−]

Read the exact number of bytes required to fill buf.

Important traits for &'_ mut F

impl<'_, F> Future for &'_ mut F where
    F: Unpin + Future + ?Sized,  type Output = <F as Future>::Output;impl<'_, I> Iterator for &'_ mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;impl<R: Read + ?Sized, '_> Read for &'_ mut Rimpl<W: Write + ?Sized, '_> Write for &'_ mut W

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

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

Important traits for Bytes<R>

impl<R: Read> Iterator for Bytes<R> type Item = Result<u8>;

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

Transforms this Read instance to an [Iterator] over its bytes.

Important traits for Chain<T, U>

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

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

Creates an adaptor which will chain this stream with another.

Important traits for Take<T>

impl<T: Read> Read for Take<T>

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

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

impl<T: BufRead, U: BufRead> BufRead for Chain<T, U>[+]

[+] Show hidden undocumented items

fn fill_buf(&mut self) -> Result<&[u8]>[−]

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

fn consume(&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(&mut self, byte: u8, buf: &mut Vec<u8>) -> Result<usize>[−]

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

fn read_line(&mut self, buf: &mut String) -> Result<usize>[−]

Read all bytes until a newline (the 0xA byte) is reached, and append them to the provided buffer.

Important traits for Split<B>

impl<B: BufRead> Iterator for Split<B> type Item = Result<Vec<u8>>;

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

Returns an iterator over the contents of this reader split on the byte byte.

Important traits for Lines<B>

impl<B: BufRead> Iterator for Lines<B> type Item = Result<String>;

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

Returns an iterator over the lines of this reader.

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

[+] Show hidden undocumented items

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

Formats the value using the given formatter.