Struct FrameReader 

pub struct FrameReader { /* private fields */ }

A frame decoder whose partial progress outlives the future that reads it.

read_frame keeps the bytes it has read inside its own future, so a caller that drops the future mid-frame — tokio::select! choosing another branch — loses them and every later frame boundary with them. This reader keeps them in buf instead: FrameReader::next awaits only AsyncReadExt::read_buf, which is cancel-safe, so dropping a next future discards nothing, and the next call resumes where the stream is.

Implementations

impl FrameReader

pub fn new() -> Self

pub async fn next<R, T>(&mut self, r: &mut R) -> Result<Option<T>>

where R: AsyncRead + Unpin, T: DeserializeOwned,

Read one frame. Cancel-safe: see the type’s documentation.

Ok(None) means the peer closed the stream at a frame boundary.

Trait Implementations

impl Debug for FrameReader

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

Formats the value using the given formatter.

impl Default for FrameReader

fn default() -> Self

Returns the “default value” for a type.