Struct aws_smithy_eventstream::frame::MessageFrameDecoder

#[non_exhaustive]
pub struct MessageFrameDecoder { /* private fields */ }

Streaming decoder for decoding a Message from a stream.

Implementations

impl MessageFrameDecoder

pub fn new() -> Self

Returns a new MessageFrameDecoder.

pub fn decode_frame<B: Buf>(&mut self, buffer: B) -> Result<DecodedFrame, Error>

Attempts to decode a Message from the given buffer. This function expects to be called over and over again with more data in the buffer each time its called. When there’s not enough data to decode a message, it returns Ok(None).

Once there is enough data to read a message prelude, then it will mutate the Buf position. The state from the reading of the prelude is stored in the decoder so that the next call will be able to decode the entire message, even though the prelude is no longer available in the Buf.

Trait Implementations

impl Debug for MessageFrameDecoder

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

Formats the value using the given formatter.

impl Default for MessageFrameDecoder

fn default() -> MessageFrameDecoder

Returns the “default value” for a type.