pub struct BufferReader<'a, const C: usize, T: AsRef<[u8]> + AsMut<[u8]>> { /* private fields */ }
Expand description
A type to read from an AsyncBuffer
Implementations§
Source§impl<'a, const C: usize, T: AsRef<[u8]> + AsMut<[u8]>> BufferReader<'a, C, T>
impl<'a, const C: usize, T: AsRef<[u8]> + AsMut<[u8]>> BufferReader<'a, C, T>
Sourcepub fn read_slice<F, U>(&self, f: F) -> Result<U, BufferError>
pub fn read_slice<F, U>(&self, f: F) -> Result<U, BufferError>
Ready from the currently available data in the BufferReader
.
The readable part of the buffer is passed to f
.
f
returns the number of bytes read and a result that is passed back to the caller.
pub fn read_slice_async<F, U>( &self, f: F, ) -> impl Future<Output = Result<U, BufferError>>
pub fn pull( &self, buf: &mut [u8], ) -> impl Future<Output = Result<(), BufferError>>
pub fn wait_for_new_data<'b>(&'b self) -> NewDataFuture<'a, 'b, C, T> ⓘ
pub fn reset(&self)
Trait Implementations§
Source§impl<'a, const C: usize, T: AsRef<[u8]> + AsMut<[u8]>> Read for BufferReader<'a, C, T>
impl<'a, const C: usize, T: AsRef<[u8]> + AsMut<[u8]>> Read for BufferReader<'a, C, T>
Source§async fn read(&mut self, buf: &mut [u8]) -> Result<usize, Self::Error>
async fn read(&mut self, buf: &mut [u8]) -> Result<usize, Self::Error>
Read some bytes from this source into the specified buffer, returning how many bytes were read. Read more
Source§async fn read_exact(
&mut self,
buf: &mut [u8],
) -> Result<(), ReadExactError<Self::Error>>
async fn read_exact( &mut self, buf: &mut [u8], ) -> Result<(), ReadExactError<Self::Error>>
Read the exact number of bytes required to fill
buf
. Read moreSource§impl<'a, const C: usize, T: AsRef<[u8]> + AsMut<[u8]>> Read for BufferReader<'a, C, T>
impl<'a, const C: usize, T: AsRef<[u8]> + AsMut<[u8]>> Read for BufferReader<'a, C, T>
Source§fn read(&mut self, buf: &mut [u8]) -> Result<usize>
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
1.36.0 · Source§fn 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 moreSource§fn is_read_vectored(&self) -> bool
fn is_read_vectored(&self) -> bool
🔬This is a nightly-only experimental API. (
can_vector
)1.0.0 · Source§fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>
fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>
Reads all bytes until EOF in this source, placing them into
buf
. Read more1.0.0 · Source§fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>
fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>
Reads all bytes until EOF in this source, appending them to
buf
. Read more1.6.0 · Source§fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>
fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>
Reads the exact number of bytes required to fill
buf
. Read moreSource§fn 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
Source§fn 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
)Reads the exact number of bytes required to fill
cursor
. Read more1.0.0 · Source§fn 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, const C: usize, T> Freeze for BufferReader<'a, C, T>
impl<'a, const C: usize, T> RefUnwindSafe for BufferReader<'a, C, T>
impl<'a, const C: usize, T> Send for BufferReader<'a, C, T>where
T: Send,
impl<'a, const C: usize, T> Sync for BufferReader<'a, C, T>where
T: Send,
impl<'a, const C: usize, T> Unpin for BufferReader<'a, C, T>
impl<'a, const C: usize, T> UnwindSafe for BufferReader<'a, C, T>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more