Struct buffered_reader::Reserve

pub struct Reserve<T: BufferedReader<C>, C: Debug + Sync + Send> { /* private fields */ }

A Reserve allows a reader to read everything except for the last N bytes (the reserve) from the underlying BufferedReader.

Note: because the Reserve doesn’t generally know how much data can be read from the underlying BufferedReader, it causes at least N bytes to by buffered.

Implementations

impl<T: BufferedReader<()>> Reserve<T, ()>

pub fn new(reader: T, reserve: usize) -> Self

Instantiates a new Reserve.

reader is the source to wrap. reserve is the number of bytes that will not be returned to the reader.

impl<T: BufferedReader<C>, C: Debug + Sync + Send> Reserve<T, C>

pub fn with_cookie(reader: T, reserve: usize, cookie: C) -> Reserve<T, C>

Like Self::new, but sets a cookie.

The cookie can be retrieved using the BufferedReader::cookie_ref and BufferedReader::cookie_mut methods, and set using the BufferedReader::cookie_set method.

Trait Implementations

impl<T: BufferedReader<C>, C: Debug + Send + Sync> BufferedReader<C> for Reserve<T, C>

fn data(&mut self, amount: usize) -> Result<&[u8], Error>

Return the buffer. Ensure that it contains at least amount bytes.

fn buffer(&self) -> &[u8]

Returns a reference to the internal buffer.

fn consume(&mut self, amount: usize) -> &[u8]

Consumes some of the data.

fn data_consume(&mut self, amount: usize) -> Result<&[u8], Error>

A convenience function that combines BufferedReader::data and BufferedReader::consume.

fn data_consume_hard(&mut self, amount: usize) -> Result<&[u8], Error>

A convenience function that effectively combines BufferedReader::data_hard and BufferedReader::consume.

fn get_mut(&mut self) -> Option<&mut dyn BufferedReader<C>>

Returns a mutable reference to the inner BufferedReader, if any.

fn get_ref(&self) -> Option<&dyn BufferedReader<C>>

Returns a reference to the inner BufferedReader, if any.

fn into_inner<'b>(self: Box<Self>) -> Option<Box<dyn BufferedReader<C> + 'b>>

where Self: 'b,

Returns the underlying reader, if any.

fn cookie_set(&mut self, cookie: C) -> C

Sets the BufferedReader’s cookie and returns the old value.

fn cookie_ref(&self) -> &C

Returns a reference to the BufferedReader’s cookie.

fn cookie_mut(&mut self) -> &mut C

Returns a mutable reference to the BufferedReader’s cookie.

fn data_hard(&mut self, amount: usize) -> Result<&[u8], Error>

Like BufferedReader::data, but returns an error if there is not at least amount bytes available.

fn data_eof(&mut self) -> Result<&[u8], Error>

Returns all of the data until EOF. Like BufferedReader::data, this does not actually consume the data that is read.

fn eof(&mut self) -> bool

Checks whether the end of the stream is reached.

fn consummated(&mut self) -> bool

Checks whether this reader is consummated.

fn read_be_u16(&mut self) -> Result<u16, Error>

A convenience function for reading a 16-bit unsigned integer in big endian format.

fn read_be_u32(&mut self) -> Result<u32, Error>

A convenience function for reading a 32-bit unsigned integer in big endian format.

fn read_to(&mut self, terminal: u8) -> Result<&[u8], Error>

Reads until either terminal is encountered or EOF.

fn drop_until(&mut self, terminals: &[u8]) -> Result<usize, Error>

Discards the input until one of the bytes in terminals is encountered.

fn drop_through( &mut self, terminals: &[u8], match_eof: bool ) -> Result<(Option<u8>, usize), Error>

Discards the input until one of the bytes in terminals is encountered.

fn steal(&mut self, amount: usize) -> Result<Vec<u8>, Error>

Like BufferedReader::data_consume_hard, but returns the data in a caller-owned buffer.

fn steal_eof(&mut self) -> Result<Vec<u8>, Error>

Like BufferedReader::steal, but instead of stealing a fixed number of bytes, steals all of the data until the end of file.

fn drop_eof(&mut self) -> Result<bool, Error>

Like BufferedReader::steal_eof, but instead of returning the data, the data is discarded.

fn copy(&mut self, sink: &mut dyn Write) -> Result<u64>

Copies data to the given writer returning the copied amount.

fn dump(&self, sink: &mut dyn Write) -> Result<()>

where Self: Sized,

A helpful debugging aid to pretty print a Buffered Reader stack.

fn into_boxed<'a>(self) -> Box<dyn BufferedReader<C> + 'a>

where Self: 'a + Sized,

Boxes the reader.

fn as_boxed<'a>(self) -> Box<dyn BufferedReader<C> + 'a>

where Self: 'a + Sized,

👎Deprecated: Use into_boxed

Boxes the reader.

impl<T: Debug + BufferedReader<C>, C: Debug + Debug + Sync + Send> Debug for Reserve<T, C>

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

Formats the value using the given formatter.

impl<T: BufferedReader<C>, C: Debug + Sync + Send> Display for Reserve<T, C>

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

Formats the value using the given formatter.

impl<T: BufferedReader<C>, C: Debug + Sync + Send> Read for Reserve<T, C>

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

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

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

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

fn is_read_vectored(&self) -> bool

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

Determines if this Reader has an efficient read_vectored implementation.

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

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

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

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

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

Read the exact number of bytes required to fill buf.

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

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

Pull some bytes from this source into the specified buffer.

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

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

Read the exact number of bytes required to fill cursor.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

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

fn bytes(self) -> Bytes<Self>

where Self: Sized,

Transforms this Read instance to an Iterator over its bytes.

fn chain<R>(self, next: R) -> Chain<Self, R>

where R: Read, Self: Sized,

Creates an adapter which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>

where Self: Sized,

Creates an adapter which will read at most limit bytes from it.