Struct axstd::io::BufReader

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

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

Implementations

impl<R> BufReader<R>

where R: Read,

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

Creates a new BufReader<R> with a default buffer capacity (1 KB).

impl<R> BufReader<R>

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

Gets a reference to the underlying reader.

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

Gets a mutable reference to the underlying reader.

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.

pub const fn capacity(&self) -> usize

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

pub fn into_inner(self) -> R

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

Trait Implementations

impl<R> BufRead for BufReader<R>

where R: Read,

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

Returns the contents of the internal buffer, filling it with more data from the inner reader if it is empty.

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.

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

Check if the underlying Read has any data left to be read.

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

Available on crate feature alloc only.

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

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

Available on crate feature alloc only.

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

impl<R> Read for BufReader<R>

where R: Read,

fn read(&mut self, buf: &mut [u8]) -> Result<usize, AxError>

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

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

Read the exact number of bytes required to fill buf.

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

Available on crate feature alloc only.

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

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

Available on crate feature alloc only.

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

fn read_full(&mut self, buf: &mut [u8]) -> Result<usize, AxError>

Read the exact number of bytes required to fill buf.