BufferReader

Struct BufferReader 

Source
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>

Source

pub fn read_slice<F, U>(&self, f: F) -> Result<U, BufferError>
where F: FnOnce(&[u8]) -> (usize, U),

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.

Source

pub fn read_slice_async<F, U>( &self, f: F, ) -> impl Future<Output = Result<U, BufferError>>
where F: FnMut(&[u8]) -> ReadSliceAsyncResult<U>,

Source

pub fn pull( &self, buf: &mut [u8], ) -> impl Future<Output = Result<(), BufferError>>

Source

pub fn wait_for_new_data<'b>(&'b self) -> NewDataFuture<'a, 'b, C, T>

Source

pub fn reset(&self)

Trait Implementations§

Source§

impl<'a, const C: usize, T: AsRef<[u8]> + AsMut<[u8]>> ErrorType for BufferReader<'a, C, T>

Source§

type Error = ErrorKind

Error type of all the IO operations on this type.
Source§

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>

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>>

Read the exact number of bytes required to fill buf. Read more
Source§

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>

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>

Like read, except that it reads into a slice of buffers. Read more
Source§

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. Read more
1.0.0 · Source§

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 more
1.0.0 · Source§

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 more
1.6.0 · Source§

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

Reads the exact number of bytes required to fill buf. Read more
Source§

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>

🔬This is a nightly-only experimental API. (read_buf)
Reads the exact number of bytes required to fill cursor. Read more
1.0.0 · Source§

fn by_ref(&mut self) -> &mut Self
where Self: Sized,

Creates a “by reference” adaptor for this instance of Read. Read more
1.0.0 · Source§

fn bytes(self) -> Bytes<Self>
where Self: Sized,

Transforms this Read instance to an Iterator over its bytes. Read more
1.0.0 · Source§

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

Creates an adapter which will chain this stream with another. Read more
1.0.0 · Source§

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

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

Auto 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> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.