Struct DoipCodec

pub struct DoipCodec {}

A simple Decoder and Encoder implementation for Diagnostics over Internet Protocol.

Can be used independently via encode and decode methods, however is best utilised during.

Trait Implementations

impl Debug for DoipCodec

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

Formats the value using the given formatter.

impl Decoder for DoipCodec

type Item = DoipMessage

The type of decoded frames.

type Error = Error

The type of unrecoverable frame decoding errors.

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

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, 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 Encoder<DoipMessage> for DoipCodec

type Error = Error

The type of encoding errors.

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

Encodes a frame into the buffer provided.