Struct pulsar::message::Codec

pub struct Codec;

Trait Implementations

impl Decoder for Codec

type Item = Message

The type of decoded frames.

type Error = ConnectionError

The type of unrecoverable frame decoding errors.

fn decode(
    &mut self,
    src: &mut BytesMut
) -> Result<Option<Message>, ConnectionError>

Attempts to decode a frame from the provided buffer of bytes.

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, 

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 Decoder for Codec

type Item = Message

The type of items returned by decode

type Error = ConnectionError

The type of decoding errors.

fn decode(
    &mut self,
    src: &mut BytesMut
) -> Result<Option<Message>, ConnectionError>

Decode an item from the src BytesMut into an item

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

Called when the input stream reaches EOF, signaling a last attempt to decode

impl Encoder<Message> for Codec

type Error = ConnectionError

The type of encoding errors.

fn encode(
    &mut self,
    item: Message,
    dst: &mut BytesMut
) -> Result<(), ConnectionError>

Encodes a frame into the buffer provided.

impl Encoder for Codec

type Item = Message

The type of items consumed by encode

type Error = ConnectionError

The type of encoding errors.

fn encode(
    &mut self,
    item: Message,
    dst: &mut BytesMut
) -> Result<(), ConnectionError>

Encodes an item into the BytesMut provided by dst.