# Struct bytes::buf::Reader [−] [src]

    pub struct Reader<B> { /* fields omitted */ }

A `Buf` adapter which implements `io::Read` for the inner value.

This struct is generally created by calling `reader()` on `Buf`. See documentation of `reader()` for more details.

## Implementations

### `impl<B: Buf> Reader<B>` [src]

#### `pub fn get_ref(&self) -> &B` [src]

Gets a reference to the underlying `Buf`.

It is inadvisable to directly read from the underlying `Buf`.

# Examples

    use bytes::Buf;

    let buf = b"hello world".reader();

    assert_eq!(b"hello world", buf.get_ref());

#### `pub fn get_mut(&mut self) -> &mut B` [src]

Gets a mutable reference to the underlying `Buf`.

It is inadvisable to directly read from the underlying `Buf`.

#### `pub fn into_inner(self) -> B` [src]

Consumes this `Reader`, returning the underlying value.

# Examples

    use bytes::Buf;
    use std::io;

    let mut buf = b"hello world".reader();
    let mut dst = vec![];

    io::copy(&mut buf, &mut dst).unwrap();

    let buf = buf.into_inner();
    assert_eq!(0, buf.remaining());

## Trait Implementations

### `impl<B: Buf + Sized> BufRead for Reader<B>` [src]

#### `fn fill_buf(&mut self) -> Result<&[u8]>` [src]

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)` [src]

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

#### `pub fn read_until(
&mut self,
byte: u8,
buf: &mut Vec<u8, Global>
) -> Result<usize, Error>`1.0.0 [src]

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

#### `pub fn read_line(&mut self, buf: &mut String) -> Result<usize, Error>`1.0.0 [src]

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

#### `pub fn split(self, byte: u8) -> Split<Self>`1.0.0 [src]

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

#### `pub fn lines(self) -> Lines<Self>`1.0.0 [src]

Returns an iterator over the lines of this reader. Read more

### `impl<B: Debug> Debug for Reader<B>` [src]

#### `fn fmt(&self, f: &mut Formatter<'_>) -> Result` [src]

Formats the value using the given formatter. Read more

### `impl<B: Buf + Sized> Read for Reader<B>` [src]

#### `fn read(&mut self, dst: &mut [u8]) -> Result<usize>` [src]

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

#### `pub fn read_vectored(
&mut self,
bufs: &mut [IoSliceMut<'_>]
) -> Result<usize, Error>`1.36.0 [src]

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

#### `pub fn is_read_vectored(&self) -> bool` [src]

🔬 This is a nightly-only experimental API. (`can_vector`)

Determines if this `Read`er has an efficient `read_vectored` implementation. Read more

#### `pub unsafe fn initializer(&self) -> Initializer` [src]

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

Determines if this `Read`er can work with buffers of uninitialized memory. Read more

#### `pub fn read_to_end(&mut self, buf: &mut Vec<u8, Global>) -> Result<usize, Error>`1.0.0 [src]

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

#### `pub fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>`1.0.0 [src]

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

#### `pub fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>`1.6.0 [src]

Read the exact number of bytes required to fill `buf`. Read more

#### `pub fn by_ref(&mut self) -> &mut Self` 1.0.0 [src]

Creates a “by reference” adaptor for this instance of `Read`. Read more

#### `pub fn bytes(self) -> Bytes<Self>`1.0.0 [src]

Transforms this `Read` instance to an `Iterator` over its bytes. Read more

#### `pub fn chain<R>(self, next: R) -> Chain<Self, R> where
R: Read,` 1.0.0 [src]

Creates an adaptor which will chain this stream with another. Read more

#### `pub fn take(self, limit: u64) -> Take<Self>`1.0.0 [src]

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

## Auto Trait Implementations

### `impl<B> RefUnwindSafe for Reader<B> where
B: RefUnwindSafe,`

### `impl<B> Send for Reader<B> where
B: Send,`

### `impl<B> Sync for Reader<B> where
B: Sync,`

### `impl<B> Unpin for Reader<B> where
B: Unpin,`

### `impl<B> UnwindSafe for Reader<B> where
B: UnwindSafe,`

## Blanket Implementations

### `impl<T> Any for T where
T: 'static + ?Sized,` [src]

#### `pub fn type_id(&self) -> TypeId` [src]

Gets the `TypeId` of `self`. Read more

### `impl<T> Borrow<T> for T where
T: ?Sized,` [src]

#### `pub fn borrow(&self) -> &T` [src]

Immutably borrows from an owned value. Read more

### `impl<T> BorrowMut<T> for T where
T: ?Sized,` [src]

#### `pub fn borrow_mut(&mut self) -> &mut T` [src]

Mutably borrows from an owned value. Read more

### `impl<T> From<T> for T` [src]

#### `pub fn from(t: T) -> T` [src]

Performs the conversion.

### `impl<T, U> Into<U> for T where
U: From<T>,` [src]

#### `pub fn into(self) -> U` [src]

Performs the conversion.

### `impl<T, U> TryFrom<U> for T where
U: Into<T>,` [src]

#### `type Error = Infallible`

The type returned in the event of a conversion error.

#### `pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>` [src]

Performs the conversion.

### `impl<T, U> TryInto<U> for T where
U: TryFrom<T>,` [src]

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

The type returned in the event of a conversion error.

#### `pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>` [src]

Performs the conversion.