Struct buffered_reader::BufferedReaderReserve
source · pub struct BufferedReaderReserve<'a, C> { /* private fields */ }
Expand description
A BufferedReaderReserve
allows a reader to read everything
except for the last N bytes (the reserve) from the underlying
BufferedReader
.
Note: because the BufferedReaderReserve
doesn’t generally know
how much data can be read from the underlying BufferedReader
,
it causes at least N bytes to by buffered.
Implementations
sourceimpl<'a> BufferedReaderReserve<'a, ()>
impl<'a> BufferedReaderReserve<'a, ()>
sourceimpl<'a, C> BufferedReaderReserve<'a, C>
impl<'a, C> BufferedReaderReserve<'a, C>
Like new()
, but sets a cookie.
The cookie can be retrieved using the cookie_ref
and
cookie_mut
methods, and set using the cookie_set
method.
Trait Implementations
sourceimpl<'a, C> BufferedReader<C> for BufferedReaderReserve<'a, C>
impl<'a, C> BufferedReader<C> for BufferedReaderReserve<'a, C>
sourcefn data(&mut self, amount: usize) -> Result<&[u8], Error>
fn data(&mut self, amount: usize) -> Result<&[u8], Error>
Return the buffer. Ensure that it contains at least amount
bytes.
sourcefn buffer(&self) -> &[u8]ⓘNotable traits for &mut [u8]impl Write for &mut [u8]impl Read for &[u8]
fn buffer(&self) -> &[u8]ⓘNotable traits for &mut [u8]impl Write for &mut [u8]impl Read for &[u8]
Returns a reference to the internal buffer. Read more
sourcefn consume(&mut self, amount: usize) -> &[u8]ⓘNotable traits for &mut [u8]impl Write for &mut [u8]impl Read for &[u8]
fn consume(&mut self, amount: usize) -> &[u8]ⓘNotable traits for &mut [u8]impl Write for &mut [u8]impl Read for &[u8]
Consumes some of the data. Read more
sourcefn get_mut(&mut self) -> Option<&mut dyn BufferedReader<C>>
fn get_mut(&mut self) -> Option<&mut dyn BufferedReader<C>>
Returns a mutable reference to the inner
BufferedReader
, if
any. Read moresourcefn get_ref(&self) -> Option<&dyn BufferedReader<C>>
fn get_ref(&self) -> Option<&dyn BufferedReader<C>>
Returns a reference to the inner
BufferedReader
, if any.sourcefn into_inner<'b>(self: Box<Self>) -> Option<Box<dyn BufferedReader<C> + 'b>>where
Self: 'b,
fn into_inner<'b>(self: Box<Self>) -> Option<Box<dyn BufferedReader<C> + 'b>>where
Self: 'b,
Returns the underlying reader, if any. Read more
Sets the
BufferedReader
’s cookie and returns the old value.Returns a reference to the
BufferedReader
’s cookie.Returns a mutable reference to the
BufferedReader
’s cookie.sourcefn data_eof(&mut self) -> Result<&[u8], Error>
fn data_eof(&mut self) -> Result<&[u8], Error>
Returns all of the data until EOF. Like
data()
, this does not
actually consume the data that is read. Read moresourcefn read_be_u16(&mut self) -> Result<u16, Error>
fn read_be_u16(&mut self) -> Result<u16, Error>
A convenience function for reading a 16-bit unsigned integer
in big endian format. Read more
sourcefn read_be_u32(&mut self) -> Result<u32, Error>
fn read_be_u32(&mut self) -> Result<u32, Error>
A convenience function for reading a 32-bit unsigned integer
in big endian format. Read more
sourcefn read_to(&mut self, terminal: u8) -> Result<&[u8], Error>
fn read_to(&mut self, terminal: u8) -> Result<&[u8], Error>
Reads until either
terminal
is encountered or EOF. Read moresourcefn steal(&mut self, amount: usize) -> Result<Vec<u8>, Error>
fn steal(&mut self, amount: usize) -> Result<Vec<u8>, Error>
Like
data_consume_hard()
, but returns the data in a
caller-owned buffer. Read moresourceimpl<'a, C> Debug for BufferedReaderReserve<'a, C>
impl<'a, C> Debug for BufferedReaderReserve<'a, C>
sourceimpl<'a, C> Display for BufferedReaderReserve<'a, C>
impl<'a, C> Display for BufferedReaderReserve<'a, C>
sourceimpl<'a, C> Read for BufferedReaderReserve<'a, C>
impl<'a, C> Read for BufferedReaderReserve<'a, C>
sourcefn read(&mut self, buf: &mut [u8]) -> Result<usize, Error>
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. Read more
1.36.0 · sourcefn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>
fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>
Like
read
, except that it reads into a slice of buffers. Read moresourcefn is_read_vectored(&self) -> bool
fn is_read_vectored(&self) -> bool
🔬This is a nightly-only experimental API. (
can_vector
)1.0.0 · sourcefn read_to_end(&mut self, buf: &mut Vec<u8, Global>) -> Result<usize, Error>
fn read_to_end(&mut self, buf: &mut Vec<u8, Global>) -> Result<usize, Error>
Read all bytes until EOF in this source, placing them into
buf
. Read more1.0.0 · sourcefn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>
fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>
Read all bytes until EOF in this source, appending them to
buf
. Read more1.6.0 · sourcefn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>
fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>
Read the exact number of bytes required to fill
buf
. Read moresourcefn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>
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. Read more
sourcefn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>
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
. Read more1.0.0 · sourcefn by_ref(&mut self) -> &mut Selfwhere
Self: Sized,
fn by_ref(&mut self) -> &mut Selfwhere
Self: Sized,
Creates a “by reference” adaptor for this instance of
Read
. Read moreAuto Trait Implementations
impl<'a, C> !RefUnwindSafe for BufferedReaderReserve<'a, C>
impl<'a, C> !Send for BufferedReaderReserve<'a, C>
impl<'a, C> !Sync for BufferedReaderReserve<'a, C>
impl<'a, C> Unpin for BufferedReaderReserve<'a, C>where
C: Unpin,
impl<'a, C> !UnwindSafe for BufferedReaderReserve<'a, C>
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more