Skip to main content

FrameReader

Struct FrameReader 

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

NDJSON frame reader over any AsyncRead. Reads byte-at-a-time from an INTERNAL BufReader (misuse-proof: callers cannot forget the buffering and pay a poll-per-byte penalty).

next() is cancellation-safe: all parse state lives in self; dropping the future loses no bytes.

Implementations§

Source§

impl<R: AsyncRead + Unpin> FrameReader<R>

Source

pub fn new(reader: R, max_frame: usize) -> Self

Source

pub fn into_inner(self) -> BufReader<R>

Unwrap to the BUFFERED reader half. Returns the internal BufReader — NOT the raw stream — so bytes already read ahead (e.g. a frame the peer pipelined behind the one just parsed) travel WITH the reader instead of being silently dropped. Call this only BETWEEN frames: any partially-accumulated frame bytes in the codec’s own line buffer are discarded (immediately after a successful next() that buffer is empty, so the hand-off is lossless).

Source

pub async fn next(&mut self) -> Result<Option<Inbound>>

Ok(None) = clean EOF. Violations do not consume the following frames.

EOF while discarding an oversized line still reports TooLarge (the next call returns Ok(None)). A truncated ORDINARY frame at EOF is silently dropped (matches MCP stdio convention — deliberate).

Trait Implementations§

Source§

impl<R: Debug> Debug for FrameReader<R>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<R> Freeze for FrameReader<R>
where R: Freeze,

§

impl<R> RefUnwindSafe for FrameReader<R>
where R: RefUnwindSafe,

§

impl<R> Send for FrameReader<R>
where R: Send,

§

impl<R> Sync for FrameReader<R>
where R: Sync,

§

impl<R> Unpin for FrameReader<R>
where R: Unpin,

§

impl<R> UnsafeUnpin for FrameReader<R>
where R: UnsafeUnpin,

§

impl<R> UnwindSafe for FrameReader<R>
where R: UnwindSafe,

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.