Trait BufRead

Source

pub trait BufRead: Read {
    // Required methods
    fn fill_buf(&mut self) -> Result<&[u8], AxError>;
    fn consume(&mut self, amount: usize);

    // Provided methods
    fn has_data_left(&mut self) -> Result<bool, AxError> { ... }
    fn skip_until(&mut self, byte: u8) -> Result<usize, AxError> { ... }
}

Expand description

A BufRead is a type of Reader which has an internal buffer, allowing it to perform extra ways of reading.

See [std::io::BufRead] for more details.

Required Methods§

Source

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

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

Source

fn consume(&mut self, amount: 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.