Struct FrameConsumer 

pub struct FrameConsumer { /* private fields */ }

Used to consume a frame’s worth of data, streaming as bytes arrive.

Implementations

impl FrameConsumer

pub fn poll_read_all(&mut self, waiter: &Waiter) -> Poll<Result<Bytes>>

Poll for all remaining data without blocking.

Waits until the frame is finished (written == size); then returns the remaining bytes from read_idx to the end as a single zero-copy slice.

pub async fn read_all(&mut self) -> Result<Bytes>

Return all of the remaining bytes, blocking until the frame is finished.

pub fn poll_read_all_chunks( &mut self, waiter: &Waiter, ) -> Poll<Result<Vec<Bytes>>>

Poll for all remaining bytes (split into a single-element vec for backwards compatibility with the previous chunk-based API).

pub fn poll_read_chunk( &mut self, waiter: &Waiter, ) -> Poll<Result<Option<Bytes>>>

Poll for the next chunk of bytes since the last read.

Returns whatever bytes have been written since the consumer’s read_idx — could span multiple producer writes. Returns None once the frame is finished and all bytes have been consumed.

pub async fn read_chunk(&mut self) -> Result<Option<Bytes>>

Return the next chunk of bytes since the last read.

pub fn poll_read_chunks(&mut self, waiter: &Waiter) -> Poll<Result<Vec<Bytes>>>

Poll for the next chunk; for backwards compatibility, wraps Self::poll_read_chunk in a vec (single element if any data is available).

pub async fn read_chunks(&mut self) -> Result<Vec<Bytes>>

Read the next chunk into a vector (single element if available, empty on eof).

Trait Implementations

impl Clone for FrameConsumer

fn clone(&self) -> FrameConsumer

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Deref for FrameConsumer

type Target = Frame

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.