Skip to main content

FrameReader

Struct FrameReader 

Source
pub struct FrameReader { /* private fields */ }
Expand description

Incremental frame reader that survives read timeouts.

read_frame uses read_exact, which discards bytes it already read when a timeout fires mid-frame. The stream is then misaligned: the next read parses payload bytes as a length prefix. FrameReader keeps the partial frame, so a timeout returns WouldBlock/TimedOut with nothing lost and the caller can retry, or give up once FrameReader::stalled_for is long.

Implementations§

Source§

impl FrameReader

Source

pub fn new() -> Self

Source

pub fn in_progress(&self) -> bool

True when part of a frame has been read and the rest is still due.

Source

pub fn stalled_for(&self) -> Option<Duration>

Time since the first byte of the frame in progress, if one is in progress.

Source

pub fn read<R: Read>(&mut self, r: &mut R) -> Result<FrameRead>

Read until one frame is complete. A timeout returns Err and keeps the partial frame, so a later call resumes exactly where this one stopped.

Trait Implementations§

Source§

impl Debug for FrameReader

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for FrameReader

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

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

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

fn try_from(value: U) -> Result<T, !>

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.