pub struct Framer { /* private fields */ }Expand description
The incremental framer of one streamed reply, from Framing::framer.
Implementations§
Source§impl Framer
impl Framer
Sourcepub fn push(&mut self, chunk: &[u8]) -> impl Iterator<Item = WireFrame>
pub fn push(&mut self, chunk: &[u8]) -> impl Iterator<Item = WireFrame>
Feed one transport chunk; yields every frame it completed. An SSE event whose data is only whitespace is a heartbeat, not a frame.
Sourcepub fn finish(&mut self) -> Option<WireFrame>
pub fn finish(&mut self) -> Option<WireFrame>
The stream ended: NDJSON’s unterminated last line. SSE dispatches only on a blank line, so an unterminated event is never a frame.
Sourcepub fn pending(&self) -> usize
pub fn pending(&self) -> usize
Bytes pushed but not yet part of a frame, for truncation
diagnostics: SseFramer::pending or NdjsonFramer::pending.
Trait Implementations§
Auto Trait Implementations§
impl Freeze for Framer
impl RefUnwindSafe for Framer
impl Send for Framer
impl Sync for Framer
impl Unpin for Framer
impl UnsafeUnpin for Framer
impl UnwindSafe for Framer
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more