Struct docktape::io::Chain 1.0.0[−][src]
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>
[src]
impl<T, U> Chain<T, U>
pub fn into_inner(self) -> (T, U)
1.20.0[src]
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)
1.20.0[src]
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)
1.20.0[src]
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, U> Debug for Chain<T, U> where
T: Debug,
U: Debug,
1.16.0[src]
impl<T, U> Debug for Chain<T, U> where
T: Debug,
U: Debug,
fn fmt(&self, f: &mut Formatter) -> Result<(), Error>
[src]
fn fmt(&self, f: &mut Formatter) -> Result<(), Error>
Formats the value using the given formatter. Read more
impl<T, U> Read for Chain<T, U> where
T: Read,
U: Read,
[src]
impl<T, U> Read for Chain<T, U> where
T: Read,
U: Read,
fn read(&mut self, buf: &mut [u8]) -> Result<usize, Error>
[src]
fn read(&mut self, buf: &mut [u8]) -> Result<usize, Error>
Pull some bytes from this source into the specified buffer, returning how many bytes were read. Read more
unsafe fn initializer(&self) -> Initializer
[src]
unsafe fn initializer(&self) -> Initializer
read_initializer
)Determines if this Read
er can work with buffers of uninitialized memory. Read more
fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>
[src]
fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>
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, Error>
[src]
fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>
Read all bytes until EOF in this source, appending them to buf
. Read more
fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>
1.6.0[src]
fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>
Read the exact number of bytes required to fill buf
. Read more
ⓘImportant traits for &'a mut Rfn by_ref(&mut self) -> &mut Self
[src]
fn by_ref(&mut self) -> &mut Self
Creates a "by reference" adaptor for this instance of Read
. Read more
ⓘImportant traits for Bytes<R>fn bytes(self) -> Bytes<Self>
[src]
fn bytes(self) -> Bytes<Self>
Transforms this Read
instance to an [Iterator
] over its bytes. Read more
ⓘImportant traits for Chars<R>fn chars(self) -> Chars<Self>
[src]
fn chars(self) -> Chars<Self>
: Use str::from_utf8 instead: https://doc.rust-lang.org/nightly/std/str/struct.Utf8Error.html#examples
🔬 This is a nightly-only experimental API. (io
)
the semantics of a partial read/write of where errors happen is currently unclear and may change
Transforms this Read
instance to an [Iterator
] over [char
]s. Read more
ⓘImportant traits for Chain<T, U>fn chain<R>(self, next: R) -> Chain<Self, R> where
R: Read,
[src]
fn chain<R>(self, next: R) -> Chain<Self, R> where
R: Read,
Creates an adaptor which will chain this stream with another. Read more
ⓘImportant traits for Take<T>fn take(self, limit: u64) -> Take<Self>
[src]
fn take(self, limit: u64) -> Take<Self>
Creates an adaptor which will read at most limit
bytes from it. Read more
impl<T, U> BufRead for Chain<T, U> where
T: BufRead,
U: BufRead,
1.9.0[src]
impl<T, U> BufRead for Chain<T, U> where
T: BufRead,
U: BufRead,
fn fill_buf(&mut self) -> Result<&[u8], Error>
[src]
fn fill_buf(&mut self) -> Result<&[u8], Error>
Fills the internal buffer of this object, returning the buffer contents. Read more
fn consume(&mut self, amt: usize)
[src]
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 read_until(&mut self, byte: u8, buf: &mut Vec<u8>) -> Result<usize, Error>
[src]
fn read_until(&mut self, byte: u8, buf: &mut Vec<u8>) -> Result<usize, Error>
Read all bytes into buf
until the delimiter byte
or EOF is reached. Read more
fn read_line(&mut self, buf: &mut String) -> Result<usize, Error>
[src]
fn read_line(&mut self, buf: &mut String) -> Result<usize, Error>
Read all bytes until a newline (the 0xA byte) is reached, and append them to the provided buffer. Read more
ⓘImportant traits for Split<B>fn split(self, byte: u8) -> Split<Self>
[src]
fn split(self, byte: u8) -> Split<Self>
Returns an iterator over the contents of this reader split on the byte byte
. Read more
ⓘImportant traits for Lines<B>fn lines(self) -> Lines<Self>
[src]
fn lines(self) -> Lines<Self>
Returns an iterator over the lines of this reader. Read more
impl<T, U> AsyncRead for Chain<T, U> where
T: AsyncRead,
U: AsyncRead,
[src]
impl<T, U> AsyncRead for Chain<T, U> where
T: AsyncRead,
U: AsyncRead,
unsafe fn prepare_uninitialized_buffer(&self, buf: &mut [u8]) -> bool
[src]
unsafe fn prepare_uninitialized_buffer(&self, buf: &mut [u8]) -> bool
Prepares an uninitialized buffer to be safe to pass to read
. Returns true
if the supplied buffer was zeroed out. Read more
fn poll_read(&mut self, buf: &mut [u8]) -> Result<Async<usize>, Error>
[src]
fn poll_read(&mut self, buf: &mut [u8]) -> Result<Async<usize>, Error>
Attempt to read from the AsyncRead
into buf
. Read more
fn read_buf<B>(&mut self, buf: &mut B) -> Result<Async<usize>, Error> where
B: BufMut,
[src]
fn read_buf<B>(&mut self, buf: &mut B) -> Result<Async<usize>, Error> where
B: BufMut,
Pull some bytes from this source into the specified Buf
, returning how many bytes were read. Read more
fn framed<T>(self, codec: T) -> Framed<Self, T> where
Self: AsyncWrite,
T: Decoder + Encoder,
[src]
fn framed<T>(self, codec: T) -> Framed<Self, T> where
Self: AsyncWrite,
T: Decoder + Encoder,
: Use tokio_codec::Decoder::framed instead
Provides a Stream
and Sink
interface for reading and writing to this Io
object, using Decode
and Encode
to read and write the raw data. Read more
fn split(self) -> (ReadHalf<Self>, WriteHalf<Self>) where
Self: AsyncWrite,
[src]
fn split(self) -> (ReadHalf<Self>, WriteHalf<Self>) where
Self: AsyncWrite,
Helper method for splitting this read/write object into two halves. Read more