BufReader in std::io - Rust
Description: The `BufReader<R>` struct adds buffering to any reader.

## BufReader

# Struct BufReader

1.0.0 · Source

    pub struct BufReader<R: ?Sized> { /* private fields */ }

Expand description

The `BufReader<R>` struct adds buffering to any reader.

It can be excessively inefficient to work directly with a `Read` instance. For example, every call to `read` on `TcpStream` results in a system call. A `BufReader<R>` performs large, infrequent reads on the underlying `Read` and maintains an in-memory buffer of the results.

`BufReader<R>` can improve the speed of programs that make small and repeated read calls to the same file or network socket. It does not help when reading very large amounts at once, or reading just one or a few times. It also provides no advantage when reading from a source that is already in memory, like a `Vec<u8>`.

When the `BufReader<R>` is dropped, the contents of its buffer will be discarded. Creating multiple instances of a `BufReader<R>` on the same stream can cause data loss. Reading from the underlying reader after unwrapping the `BufReader<R>` with `BufReader::into_inner` can also cause data loss.

## §Examples

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

    fn main() -> std::io::Result<()> {
        let f = File::open("log.txt")?;
        let mut reader = BufReader::new(f);

        let mut line = String::new();
        let len = reader.read_line(&mut line)?;
        println!("First line is {len} bytes long");
        Ok(())
    }

## Implementations§

Source§

### impl<R: Read> BufReader<R>

1.0.0 · Source

#### pub fn new(inner: R) -> BufReader<R> ⓘ

Creates a new `BufReader<R>` with a default buffer capacity. The default is currently 8 KiB, but may change in the future.

##### §Examples

    use std::io::BufReader;
    use std::fs::File;

    fn main() -> std::io::Result<()> {
        let f = File::open("log.txt")?;
        let reader = BufReader::new(f);
        Ok(())
    }

1.0.0 · Source

#### pub fn with_capacity(capacity: usize, inner: R) -> BufReader<R> ⓘ

Creates a new `BufReader<R>` with the specified buffer capacity.

##### §Examples

Creating a buffer with ten bytes of capacity:

    use std::io::BufReader;
    use std::fs::File;

    fn main() -> std::io::Result<()> {
        let f = File::open("log.txt")?;
        let reader = BufReader::with_capacity(10, f);
        Ok(())
    }

Source§

### impl<R: Read + ?Sized> BufReader<R>

Source

#### pub fn peek(&mut self, n: usize) -> Result<&[u8]>

🔬This is a nightly-only experimental API. (`bufreader_peek` #128405)

Attempt to look ahead `n` bytes.

`n` must be less than or equal to `capacity`.

The returned slice may be less than `n` bytes long if end of file is reached.

After calling this method, you may call `consume` with a value less than or equal to `n` to advance over some or all of the returned bytes.

###### §Examples

    #![feature(bufreader_peek)]
    use std::io::{Read, BufReader};

    let mut bytes = &b"oh, hello there"[..];
    let mut rdr = BufReader::with_capacity(6, &mut bytes);
    assert_eq!(rdr.peek(2).unwrap(), b"oh");
    let mut buf = [0; 4];
    rdr.read(&mut buf[..]).unwrap();
    assert_eq!(&buf, b"oh, ");
    assert_eq!(rdr.peek(5).unwrap(), b"hello");
    let mut s = String::new();
    rdr.read_to_string(&mut s).unwrap();
    assert_eq!(&s, "hello there");
    assert_eq!(rdr.peek(1).unwrap().len(), 0);

Source§

### impl<R: ?Sized> BufReader<R>

1.0.0 · Source

#### pub fn get_ref(&self) -> &R

Gets a reference to the underlying reader.

It is inadvisable to directly read from the underlying reader.

##### §Examples

    use std::io::BufReader;
    use std::fs::File;

    fn main() -> std::io::Result<()> {
        let f1 = File::open("log.txt")?;
        let reader = BufReader::new(f1);

        let f2 = reader.get_ref();
        Ok(())
    }

1.0.0 · Source

#### pub fn get_mut(&mut self) -> &mut R

Gets a mutable reference to the underlying reader.

It is inadvisable to directly read from the underlying reader.

##### §Examples

    use std::io::BufReader;
    use std::fs::File;

    fn main() -> std::io::Result<()> {
        let f1 = File::open("log.txt")?;
        let mut reader = BufReader::new(f1);

        let f2 = reader.get_mut();
        Ok(())
    }

1.37.0 · Source

#### pub fn buffer(&self) -> &[u8] ⓘ

Returns a reference to the internally buffered data.

Unlike `fill_buf`, this will not attempt to fill the buffer if it is empty.

##### §Examples

    use std::io::{BufReader, BufRead};
    use std::fs::File;

    fn main() -> std::io::Result<()> {
        let f = File::open("log.txt")?;
        let mut reader = BufReader::new(f);
        assert!(reader.buffer().is_empty());

        if reader.fill_buf()?.len() > 0 {
            assert!(!reader.buffer().is_empty());
        }
        Ok(())
    }

1.46.0 · Source

#### pub fn capacity(&self) -> usize

Returns the number of bytes the internal buffer can hold at once.

##### §Examples

    use std::io::{BufReader, BufRead};
    use std::fs::File;

    fn main() -> std::io::Result<()> {
        let f = File::open("log.txt")?;
        let mut reader = BufReader::new(f);

        let capacity = reader.capacity();
        let buffer = reader.fill_buf()?;
        assert!(buffer.len() <= capacity);
        Ok(())
    }

1.0.0 · Source

#### pub fn into_inner(self) -> R
where R: Sized,

Unwraps this `BufReader<R>`, returning the underlying reader.

Note that any leftover data in the internal buffer is lost. Therefore, a following read from the underlying reader may lead to data loss.

##### §Examples

    use std::io::BufReader;
    use std::fs::File;

    fn main() -> std::io::Result<()> {
        let f1 = File::open("log.txt")?;
        let reader = BufReader::new(f1);

        let f2 = reader.into_inner();
        Ok(())
    }

Source§

### impl<R: ?Sized + Seek> BufReader<R>

1.53.0 · Source

#### pub fn seek_relative(&mut self, offset: i64) -> Result<()>

Seeks relative to the current position. If the new position lies within the buffer, the buffer will not be flushed, allowing for more efficient seeks. This method does not return the location of the underlying reader, so the caller must track this information themselves if it is required.

## Trait Implementations§

1.0.0 · Source§

### impl<R: ?Sized + Read> BufRead for BufReader<R>

Source§

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

Returns the contents of the internal buffer, filling it with more data, via `Read` methods, if empty. Read more
Source§

#### fn consume(&mut self, amt: usize)

Marks the given `amount` of additional bytes from the internal buffer as having been read. Subsequent calls to `read` only return bytes that have not been marked as read. Read more
Source§

#### fn has_data_left(&mut self) -> Result<bool>

🔬This is a nightly-only experimental API. (`buf_read_has_data_left` #86423)
Checks if there is any data left to be `read`. Read more
1.0.0 · Source§

#### fn read_until(&mut self, byte: u8, buf: &mut Vec<u8>) -> Result<usize>

Reads all bytes into `buf` until the delimiter `byte` or EOF is reached. Read more
1.83.0 · Source§

#### fn skip_until(&mut self, byte: u8) -> Result<usize>

Skips all bytes until the delimiter `byte` or EOF is reached. Read more
1.0.0 · Source§

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

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

#### 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
1.0.0 · Source§

#### fn lines(self) -> Lines<Self> ⓘ
where Self: Sized,

Returns an iterator over the lines of this reader. Read more
1.0.0 · Source§

### impl<R> Debug for BufReader<R>
where R: ?Sized + Debug,

Source§

#### fn fmt(&self, fmt: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
1.0.0 · Source§

### impl<R: ?Sized + Read> Read for BufReader<R>

Source§

#### 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
Source§

#### fn read_buf(&mut self, cursor: BorrowedCursor<'_>) -> Result<()>

🔬This is a nightly-only experimental API. (`read_buf` #78485)
Pull some bytes from this source into the specified buffer. Read more
Source§

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

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

#### fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<()>

🔬This is a nightly-only experimental API. (`read_buf` #78485)
Reads the exact number of bytes required to fill `cursor`. Read more
Source§

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

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

#### fn is_read_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (`can_vector` #69941)
Determines if this `Read`er has an efficient `read_vectored` implementation. Read more
Source§

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

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

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

Reads all bytes until EOF in this source, appending them to `buf`. Read more
1.0.0 · Source§

#### fn by_ref(&mut self) -> &mut Self
where Self: Sized,

Creates a “by reference” adapter for this instance of `Read`. Read more
1.0.0 · Source§

#### fn bytes(self) -> Bytes<Self> ⓘ
where Self: Sized,

Transforms this `Read` instance to an `Iterator` over its bytes. Read more
1.0.0 · Source§

#### 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
1.0.0 · Source§

#### fn take(self, limit: u64) -> Take<Self> ⓘ
where Self: Sized,

Creates an adapter which will read at most `limit` bytes from it. Read more
Source§

#### fn read_array<const N: usize>(&mut self) -> Result<[u8; N]>
where Self: Sized,

🔬This is a nightly-only experimental API. (`read_array` #148848)
Read and return a fixed array of bytes from this source. Read more
1.0.0 · Source§

### impl<R: ?Sized + Seek> Seek for BufReader<R>

Source§

#### fn seek(&mut self, pos: SeekFrom) -> Result<u64>

Seek to an offset, in bytes, in the underlying reader.

The position used for seeking with `SeekFrom::Current(_)` is the position the underlying reader would be at if the `BufReader<R>` had no internal buffer.

Seeking always discards the internal buffer, even if the seek position would otherwise fall within it. This guarantees that calling `BufReader::into_inner()` immediately after a seek yields the underlying reader at the same position.

To seek without discarding the internal buffer, use `BufReader::seek_relative`.

See `std::io::Seek` for more details.

Note: In the edge case where you’re seeking with `SeekFrom::Current(n)` where `n` minus the internal buffer length overflows an `i64`, two seeks will be performed instead of one. If the second seek returns `Err`, the underlying reader will be left at the same position it would have if you called `seek` with `SeekFrom::Current(0)`.

Source§

#### fn stream_position(&mut self) -> Result<u64>

Returns the current seek position from the start of the stream.

The value returned is equivalent to `self.seek(SeekFrom::Current(0))` but does not flush the internal buffer. Due to this optimization the function does not guarantee that calling `.into_inner()` immediately afterwards will yield the underlying reader at the same position. Use `BufReader::seek` instead if you require that guarantee.

##### §Panics

This function will panic if the position of the inner reader is smaller than the amount of buffered data. That can happen if the inner reader has an incorrect implementation of `Seek::stream_position`, or if the position has gone out of sync due to calling `Seek::seek` directly on the underlying reader.

##### §Example

    use std::{
        io::{self, BufRead, BufReader, Seek},
        fs::File,
    };

    fn main() -> io::Result<()> {
        let mut f = BufReader::new(File::open("foo.txt")?);

        let before = f.stream_position()?;
        f.read_line(&mut String::new())?;
        let after = f.stream_position()?;

        println!("The first line was {} bytes long", after - before);
        Ok(())
    }

Source§

#### fn seek_relative(&mut self, offset: i64) -> Result<()>

Seeks relative to the current position.

If the new position lies within the buffer, the buffer will not be flushed, allowing for more efficient seeks. This method does not return the location of the underlying reader, so the caller must track this information themselves if it is required.

1.55.0 · Source§

#### fn rewind(&mut self) -> Result<()>

Rewind to the beginning of a stream. Read more
Source§

#### fn stream_len(&mut self) -> Result<u64>

🔬This is a nightly-only experimental API. (`seek_stream_len` #59359)
Returns the length of this stream (in bytes). Read more

## Auto Trait Implementations§

§

### impl<R> Freeze for BufReader<R>
where R: Freeze + ?Sized,

§

### impl<R> RefUnwindSafe for BufReader<R>
where R: RefUnwindSafe + ?Sized,

§

### impl<R> Send for BufReader<R>
where R: Send + ?Sized,

§

### impl<R> Sync for BufReader<R>
where R: Sync + ?Sized,

§

### impl<R> Unpin for BufReader<R>
where R: Unpin + ?Sized,

§

### impl<R> UnwindSafe for BufReader<R>
where R: UnwindSafe + ?Sized,

## Blanket Implementations§

Source§

### impl<T> Any for T
where T: 'static + ?Sized,

Source§

#### fn type_id(&self) -> TypeId

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

### impl<T> Borrow<T> for T
where T: ?Sized,

Source§

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

### impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

#### fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

### impl<T> From<T> for T

Source§

#### fn from(t: T) -> T

Returns the argument unchanged.

Source§

### impl<T, U> Into<U> for T
where U: From<T>,

Source§

#### fn into(self) -> U

Calls `U::from(self)`.

That is, this conversion is whatever the implementation of `From<T> for U` chooses to do.

Source§

### impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

#### type Error = Infallible

The type returned in the event of a conversion error.
Source§

#### fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

### impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

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

The type returned in the event of a conversion error.
Source§

#### fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.