Struct SseDecoder 

pub struct SseDecoder { /* private fields */ }

An incremental text/event-stream decoder.

Push bytes, pull frames. It owns a buffer for the partial line at the end of each chunk, which is why it has to be a struct and not a function.

Implementations

impl SseDecoder

pub fn new() -> Self

A decoder with the default frame size cap.

pub fn with_max_frame_size(self, bytes: usize) -> Self

Sets the cap on a single frame.

pub fn max_frame_size(&self) -> usize

The cap on a single frame, in bytes.

pub fn push(&mut self, bytes: &[u8]) -> Result<()>

Feeds the decoder a chunk of the response body.

Errors

Error::Decode when the frame being assembled exceeds SseDecoder::max_frame_size — a server that never sends a line break would otherwise grow this buffer without bound.

pub fn next_frame(&mut self) -> Result<Option<SseFrame>>

Pulls the next complete frame, if the bytes pushed so far contain one.

Errors

Error::Decode when the bytes are not UTF-8.

pub fn finish(&mut self) -> Result<Vec<SseFrame>>

Drains the decoder at the end of the stream.

A body that stops without the blank line that terminates its last frame is common enough — a closed connection, a server that forgets — that dropping the frame would lose real events. Anything still buffered is dispatched here.

Errors

Error::Decode when the trailing bytes are not UTF-8.

Trait Implementations

impl Clone for SseDecoder

fn clone(&self) -> SseDecoder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SseDecoder

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

Formats the value using the given formatter.

impl Default for SseDecoder

fn default() -> Self

Returns the “default value” for a type.