Struct StompCodec 

pub struct StompCodec {}

StompCodec implements tokio_util::codec::{Decoder, Encoder} for the STOMP wire protocol.

Responsibilities:

• Decode incoming bytes into StompItem::Frame or StompItem::Heartbeat.
• Support both NUL-terminated frames and frames using the content-length header (STOMP 1.2) for binary bodies containing NUL bytes.
• Encode StompItem back into bytes for the wire format and emit content-length when necessary.

Implementations

impl StompCodec

pub fn new() -> Self

Trait Implementations

impl Decoder for StompCodec

fn decode( &mut self, src: &mut BytesMut, ) -> Result<Option<Self::Item>, Self::Error>

Decode bytes from src into a StompItem.

Parameters

• src: a mutable reference to the read buffer containing bytes from the transport. The decoder may consume bytes from this buffer (using methods like advance or split_to) when it successfully decodes a frame. If there are not enough bytes to form a complete frame, this method should return Ok(None) and leave src in the same state.

Returns

• Ok(Some(StompItem)) when a full item (frame or heartbeat) was decoded and bytes were consumed from src accordingly.
• Ok(None) when more bytes are required to decode a complete item.
• Err(io::Error) on protocol or data errors (invalid UTF-8, malformed frames, missing NUL after a content-length body, etc.).

type Item = StompItem

The type of decoded frames.

type Error = Error

The type of unrecoverable frame decoding errors.

fn decode_eof( &mut self, buf: &mut BytesMut, ) -> Result<Option<Self::Item>, Self::Error>

A default method available to be called when there are no more bytes available to be read from the underlying I/O.

fn framed<T>(self, io: T) -> Framed<T, Self>

where T: AsyncRead + AsyncWrite, Self: Sized,

Provides a Stream and Sink interface for reading and writing to this Io object, using Decode and Encode to read and write the raw data.

impl Default for StompCodec

fn default() -> Self

Returns the “default value” for a type.

impl Encoder<StompItem> for StompCodec

fn encode( &mut self, item: StompItem, dst: &mut BytesMut, ) -> Result<(), Self::Error>

Encode a StompItem into the provided destination buffer.

Parameters

• item: the StompItem to encode. The encoder takes ownership of the item (and any contained Frame) and may consume/mutate its contents.
• dst: destination buffer where encoded bytes should be appended. This is the same BytesMut provided by the tokio_util::codec framework (e.g. Framed). Do not replace or reassign dst; instead append bytes into it using BufMut methods (put_u8, put_slice, extend_from_slice, etc.). After encode returns the contents of dst will be written to the underlying transport.

Returns

• Ok(()) on success, or Err(io::Error) on encoding-related errors.

type Error = Error

The type of encoding errors.