Struct std::io::Chain
pub struct Chain<T, U> { /* private fields */ }Adapter 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
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: BufRead, U: BufRead> BufRead for Chain<T, U>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. Read more
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. Read more
fn has_data_left(&mut self) -> Result<bool>🔬This is a nightly-only experimental API. (
buf_read_has_data_left #86423)
Check if the underlying
Read has any data left to be read. Read more
fn read_until(&mut self, byte: u8, buf: &mut Vec<u8>) -> Result<usize>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 String buffer. Read more
fn split(self, byte: u8) -> Split<Self> ⓘ
where
Self: Sized,
Returns an iterator over the contents of this reader split on the byte
byte. Read more
fn lines(self) -> Lines<Self> ⓘ
where
Self: Sized,
Returns an iterator over the lines of this reader. Read more
impl<T: Debug, U: Debug> Debug for Chain<T, U>fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
impl<T: Read, U: Read> Read for Chain<T, U>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. Read more
fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize>
Like
read, except that it reads into a slice of buffers. Read more
fn is_read_vectored(&self) -> bool🔬This is a nightly-only experimental API. (
can_vector #69941)
fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize>
Read all bytes until EOF in this source, placing them into
buf. Read more
fn read_to_string(&mut self, buf: &mut String) -> Result<usize>
Read all bytes until EOF in this source, appending them to
buf. Read more
fn read_exact(&mut self, buf: &mut [u8]) -> Result<()>
Read the exact number of bytes required to fill
buf. Read more
fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<()>🔬This is a nightly-only experimental API. (
read_buf #78485)
Pull some bytes from this source into the specified buffer. Read more
fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<()>🔬This is a nightly-only experimental API. (
read_buf #78485)
Read the exact number of bytes required to fill
cursor. Read more
fn by_ref(&mut self) -> &mut Self
where
Self: Sized,
Creates a “by reference” adaptor for this instance of
Read. Read more
fn bytes(self) -> Bytes<Self> ⓘ
where
Self: Sized,fn chain<R: Read>(self, next: R) -> Chain<Self, R> ⓘ
where
Self: Sized,
Creates an adapter which will chain this stream with another. Read more
fn take(self, limit: u64) -> Take<Self> ⓘ
where
Self: Sized,
Creates an adapter which will read at most
limit bytes from it. Read more
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> Unpin for Chain<T, U>
where
T: Unpin,
U: Unpin,impl<T, U> UnwindSafe for Chain<T, U>
where
T: UnwindSafe,
U: UnwindSafe,Blanket Implementations
impl<T> Any for T
where
T: 'static + ?Sized,impl<T> Borrow<T> for T
where
T: ?Sized,impl<T> BorrowMut<T> for T
where
T: ?Sized,impl<T> From<T> for Tfn from(t: T) -> TReturns the argument unchanged.
impl<T, U> Into<U> for T
where
U: From<T>,fn into(self) -> UCalls U::from(self).
That is, this conversion is whatever the implementation of From<T> for U chooses to do.
impl<T, U> TryFrom<U> for T
where
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>
Performs the conversion.
impl<T, U> TryInto<U> for T
where
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>
Performs the conversion.
© 2010 The Rust Project Developers
Licensed under the Apache License, Version 2.0 or the MIT license, at your option.
https://doc.rust-lang.org/std/io/struct.Chain.html