Struct DoipCodec

pub struct DoipCodec<const N: usize> {}

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<const N: usize> Debug for DoipCodec<N>

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

Formats the value using the given formatter.

impl<const N: usize> Decoder<N> for DoipCodec<N>

type Item = DoipMessage<N>

The type of decoded frames

type Error = DecodeError

The type of unrecoverable frame decoding errors.

fn from_bytes( &mut self, src: &mut Vec<u8, N>, ) -> Result<Option<Self::Item>, Self::Error>

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

impl<const N: usize> Decoder for DoipCodec<N>

type Item = DoipMessage<N>

The type of decoded frames.

type Error = DecodeError

The type of unrecoverable frame decoding errors.

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

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<const N: usize> Encoder<DoipMessage<N>> for DoipCodec<N>

type Error = EncodeError

The type of encoding errors.

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

Encodes a frame into the buffer provided.

impl<const N: usize> Encoder<DoipMessage<N>, N> for DoipCodec<N>

type Error = EncodeError

The type of encoding errors.

fn to_bytes( &mut self, item: DoipMessage<N>, dst: &mut Vec<u8, N>, ) -> Result<(), Self::Error>

Encodes a frame into the buffer provided.