Struct tokio_util::io::StreamReader [−][src]
pub struct StreamReader<S, B> { /* fields omitted */ }
io
only.Expand description
Convert a Stream
of byte chunks into an AsyncRead
.
This type performs the inverse operation of ReaderStream
.
Example
use bytes::Bytes; use tokio::io::{AsyncReadExt, Result}; use tokio_util::io::StreamReader; // Create a stream from an iterator. let stream = tokio_stream::iter(vec![ Result::Ok(Bytes::from_static(&[0, 1, 2, 3])), Result::Ok(Bytes::from_static(&[4, 5, 6, 7])), Result::Ok(Bytes::from_static(&[8, 9, 10, 11])), ]); // Convert it to an AsyncRead. let mut read = StreamReader::new(stream); // Read five bytes from the stream. let mut buf = [0; 5]; read.read_exact(&mut buf).await?; assert_eq!(buf, [0, 1, 2, 3, 4]); // Read the rest of the current chunk. assert_eq!(read.read(&mut buf).await?, 3); assert_eq!(&buf[..3], [5, 6, 7]); // Read the next chunk. assert_eq!(read.read(&mut buf).await?, 4); assert_eq!(&buf[..4], [8, 9, 10, 11]); // We have now reached the end. assert_eq!(read.read(&mut buf).await?, 0);
Implementations
impl<S, B, E> StreamReader<S, B> where
S: Stream<Item = Result<B, E>>,
B: Buf,
E: Into<Error>,
[src]
impl<S, B, E> StreamReader<S, B> where
S: Stream<Item = Result<B, E>>,
B: Buf,
E: Into<Error>,
[src]impl<S, B> StreamReader<S, B>
[src]
impl<S, B> StreamReader<S, B>
[src]pub fn get_ref(&self) -> &S
[src]
pub fn get_ref(&self) -> &S
[src]Gets a reference to the underlying stream.
It is inadvisable to directly read from the underlying stream.
pub fn get_mut(&mut self) -> &mut S
[src]
pub fn get_mut(&mut self) -> &mut S
[src]Gets a mutable reference to the underlying stream.
It is inadvisable to directly read from the underlying stream.
pub fn get_pin_mut(self: Pin<&mut Self>) -> Pin<&mut S>
[src]
pub fn get_pin_mut(self: Pin<&mut Self>) -> Pin<&mut S>
[src]Gets a pinned mutable reference to the underlying stream.
It is inadvisable to directly read from the underlying stream.
pub fn into_inner(self) -> S
[src]
pub fn into_inner(self) -> S
[src]Consumes this BufWriter
, returning the underlying stream.
Note that any leftover data in the internal buffer is lost.
Trait Implementations
impl<S, B, E> AsyncBufRead for StreamReader<S, B> where
S: Stream<Item = Result<B, E>>,
B: Buf,
E: Into<Error>,
[src]
impl<S, B, E> AsyncBufRead for StreamReader<S, B> where
S: Stream<Item = Result<B, E>>,
B: Buf,
E: Into<Error>,
[src]impl<S, B, E> AsyncRead for StreamReader<S, B> where
S: Stream<Item = Result<B, E>>,
B: Buf,
E: Into<Error>,
[src]
impl<S, B, E> AsyncRead for StreamReader<S, B> where
S: Stream<Item = Result<B, E>>,
B: Buf,
E: Into<Error>,
[src]impl<S: Debug, B: Debug> Debug for StreamReader<S, B>
[src]
impl<S: Debug, B: Debug> Debug for StreamReader<S, B>
[src]impl<'__pin, S, B> Unpin for StreamReader<S, B> where
__Origin<'__pin, S, B>: Unpin,
[src]
__Origin<'__pin, S, B>: Unpin,
Auto Trait Implementations
impl<S, B> RefUnwindSafe for StreamReader<S, B> where
B: RefUnwindSafe,
S: RefUnwindSafe,
B: RefUnwindSafe,
S: RefUnwindSafe,
impl<S, B> Send for StreamReader<S, B> where
B: Send,
S: Send,
B: Send,
S: Send,
impl<S, B> Sync for StreamReader<S, B> where
B: Sync,
S: Sync,
B: Sync,
S: Sync,
impl<S, B> UnwindSafe for StreamReader<S, B> where
B: UnwindSafe,
S: UnwindSafe,
B: UnwindSafe,
S: UnwindSafe,
Blanket Implementations
impl<R> AsyncBufReadExt for R where
R: AsyncBufRead + ?Sized,
[src]
impl<R> AsyncBufReadExt for R where
R: AsyncBufRead + ?Sized,
[src]fn read_until(
&'a mut self,
byte: u8,
buf: &'a mut Vec<u8, Global>
) -> ReadUntil<'a, Self> where
Self: Unpin,
[src]
fn read_until(
&'a mut self,
byte: u8,
buf: &'a mut Vec<u8, Global>
) -> ReadUntil<'a, Self> where
Self: Unpin,
[src]Reads all bytes into buf
until the delimiter byte
or EOF is reached. Read more
fn read_line(&'a mut self, buf: &'a mut String) -> ReadLine<'a, Self> where
Self: Unpin,
[src]
fn read_line(&'a mut self, buf: &'a mut String) -> ReadLine<'a, Self> where
Self: Unpin,
[src]Reads all bytes until a newline (the 0xA byte) is reached, and append them to the provided buffer. Read more
fn split(self, byte: u8) -> Split<Self> where
Self: Unpin,
[src]
fn split(self, byte: u8) -> Split<Self> where
Self: Unpin,
[src]Returns a stream of the contents of this reader split on the byte
byte
. Read more
fn lines(self) -> Lines<Self>
[src]
fn lines(self) -> Lines<Self>
[src]Returns a stream over the lines of this reader.
This method is the async equivalent to BufRead::lines
. Read more
impl<R> AsyncReadExt for R where
R: AsyncRead + ?Sized,
[src]
impl<R> AsyncReadExt for R where
R: AsyncRead + ?Sized,
[src]fn chain<R>(self, next: R) -> Chain<Self, R> where
R: AsyncRead,
[src]
fn chain<R>(self, next: R) -> Chain<Self, R> where
R: AsyncRead,
[src]Creates a new AsyncRead
instance that chains this stream with
next
. Read more
fn read(&'a mut self, buf: &'a mut [u8]) -> Read<'a, Self> where
Self: Unpin,
[src]
fn read(&'a mut self, buf: &'a mut [u8]) -> Read<'a, Self> where
Self: Unpin,
[src]Pulls some bytes from this source into the specified buffer, returning how many bytes were read. Read more
fn read_buf<B>(&'a mut self, buf: &'a mut B) -> ReadBuf<'a, Self, B> where
Self: Unpin,
B: BufMut,
[src]
fn read_buf<B>(&'a mut self, buf: &'a mut B) -> ReadBuf<'a, Self, B> where
Self: Unpin,
B: BufMut,
[src]Pulls some bytes from this source into the specified buffer, advancing the buffer’s internal cursor. Read more
fn read_exact(&'a mut self, buf: &'a mut [u8]) -> ReadExact<'a, Self> where
Self: Unpin,
[src]
fn read_exact(&'a mut self, buf: &'a mut [u8]) -> ReadExact<'a, Self> where
Self: Unpin,
[src]Reads the exact number of bytes required to fill buf
. Read more
fn read_u8(&'a mut self) -> ReadU8<&'a mut Self> where
Self: Unpin,
[src]
fn read_u8(&'a mut self) -> ReadU8<&'a mut Self> where
Self: Unpin,
[src]Reads an unsigned 8 bit integer from the underlying reader. Read more
fn read_i8(&'a mut self) -> ReadI8<&'a mut Self> where
Self: Unpin,
[src]
fn read_i8(&'a mut self) -> ReadI8<&'a mut Self> where
Self: Unpin,
[src]Reads a signed 8 bit integer from the underlying reader. Read more
fn read_u16(&'a mut self) -> ReadU16<&'a mut Self> where
Self: Unpin,
[src]
fn read_u16(&'a mut self) -> ReadU16<&'a mut Self> where
Self: Unpin,
[src]Reads an unsigned 16-bit integer in big-endian order from the underlying reader. Read more
fn read_i16(&'a mut self) -> ReadI16<&'a mut Self> where
Self: Unpin,
[src]
fn read_i16(&'a mut self) -> ReadI16<&'a mut Self> where
Self: Unpin,
[src]Reads a signed 16-bit integer in big-endian order from the underlying reader. Read more
fn read_u32(&'a mut self) -> ReadU32<&'a mut Self> where
Self: Unpin,
[src]
fn read_u32(&'a mut self) -> ReadU32<&'a mut Self> where
Self: Unpin,
[src]Reads an unsigned 32-bit integer in big-endian order from the underlying reader. Read more
fn read_i32(&'a mut self) -> ReadI32<&'a mut Self> where
Self: Unpin,
[src]
fn read_i32(&'a mut self) -> ReadI32<&'a mut Self> where
Self: Unpin,
[src]Reads a signed 32-bit integer in big-endian order from the underlying reader. Read more
fn read_u64(&'a mut self) -> ReadU64<&'a mut Self> where
Self: Unpin,
[src]
fn read_u64(&'a mut self) -> ReadU64<&'a mut Self> where
Self: Unpin,
[src]Reads an unsigned 64-bit integer in big-endian order from the underlying reader. Read more
fn read_i64(&'a mut self) -> ReadI64<&'a mut Self> where
Self: Unpin,
[src]
fn read_i64(&'a mut self) -> ReadI64<&'a mut Self> where
Self: Unpin,
[src]Reads an signed 64-bit integer in big-endian order from the underlying reader. Read more
fn read_u128(&'a mut self) -> ReadU128<&'a mut Self> where
Self: Unpin,
[src]
fn read_u128(&'a mut self) -> ReadU128<&'a mut Self> where
Self: Unpin,
[src]Reads an unsigned 128-bit integer in big-endian order from the underlying reader. Read more
fn read_i128(&'a mut self) -> ReadI128<&'a mut Self> where
Self: Unpin,
[src]
fn read_i128(&'a mut self) -> ReadI128<&'a mut Self> where
Self: Unpin,
[src]Reads an signed 128-bit integer in big-endian order from the underlying reader. Read more
fn read_u16_le(&'a mut self) -> ReadU16Le<&'a mut Self> where
Self: Unpin,
[src]
fn read_u16_le(&'a mut self) -> ReadU16Le<&'a mut Self> where
Self: Unpin,
[src]Reads an unsigned 16-bit integer in little-endian order from the underlying reader. Read more
fn read_i16_le(&'a mut self) -> ReadI16Le<&'a mut Self> where
Self: Unpin,
[src]
fn read_i16_le(&'a mut self) -> ReadI16Le<&'a mut Self> where
Self: Unpin,
[src]Reads a signed 16-bit integer in little-endian order from the underlying reader. Read more
fn read_u32_le(&'a mut self) -> ReadU32Le<&'a mut Self> where
Self: Unpin,
[src]
fn read_u32_le(&'a mut self) -> ReadU32Le<&'a mut Self> where
Self: Unpin,
[src]Reads an unsigned 32-bit integer in little-endian order from the underlying reader. Read more
fn read_i32_le(&'a mut self) -> ReadI32Le<&'a mut Self> where
Self: Unpin,
[src]
fn read_i32_le(&'a mut self) -> ReadI32Le<&'a mut Self> where
Self: Unpin,
[src]Reads a signed 32-bit integer in little-endian order from the underlying reader. Read more
fn read_u64_le(&'a mut self) -> ReadU64Le<&'a mut Self> where
Self: Unpin,
[src]
fn read_u64_le(&'a mut self) -> ReadU64Le<&'a mut Self> where
Self: Unpin,
[src]Reads an unsigned 64-bit integer in little-endian order from the underlying reader. Read more
fn read_i64_le(&'a mut self) -> ReadI64Le<&'a mut Self> where
Self: Unpin,
[src]
fn read_i64_le(&'a mut self) -> ReadI64Le<&'a mut Self> where
Self: Unpin,
[src]Reads an signed 64-bit integer in little-endian order from the underlying reader. Read more
fn read_u128_le(&'a mut self) -> ReadU128Le<&'a mut Self> where
Self: Unpin,
[src]
fn read_u128_le(&'a mut self) -> ReadU128Le<&'a mut Self> where
Self: Unpin,
[src]Reads an unsigned 128-bit integer in little-endian order from the underlying reader. Read more
fn read_i128_le(&'a mut self) -> ReadI128Le<&'a mut Self> where
Self: Unpin,
[src]
fn read_i128_le(&'a mut self) -> ReadI128Le<&'a mut Self> where
Self: Unpin,
[src]Reads an signed 128-bit integer in little-endian order from the underlying reader. Read more
fn read_to_end(
&'a mut self,
buf: &'a mut Vec<u8, Global>
) -> ReadToEnd<'a, Self> where
Self: Unpin,
[src]
fn read_to_end(
&'a mut self,
buf: &'a mut Vec<u8, Global>
) -> ReadToEnd<'a, Self> where
Self: Unpin,
[src]Reads all bytes until EOF in this source, placing them into buf
. Read more
fn read_to_string(&'a mut self, dst: &'a mut String) -> ReadToString<'a, Self> where
Self: Unpin,
[src]
fn read_to_string(&'a mut self, dst: &'a mut String) -> ReadToString<'a, Self> where
Self: Unpin,
[src]Reads all bytes until EOF in this source, appending them to buf
. Read more
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<T> TokioAsyncReadCompatExt for T where
T: AsyncRead,
[src]
impl<T> TokioAsyncReadCompatExt for T where
T: AsyncRead,
[src]