Struct TlvCodec 

pub struct TlvCodec;

tokio_util::codec implementation for NDN TLV framing over byte streams.

NDN uses length-prefix framing: each frame is a complete TLV element [type | length | value] where both type and length are varu64-encoded. This codec reassembles frames from the byte stream and passes complete TLV buffers up to the face.

Wire format

┌──────────┬──────────┬─────────────────┐
│ type     │ length   │ value           │
│ (varu64) │ (varu64) │ (length bytes)  │
└──────────┴──────────┴─────────────────┘

Both TcpFace and SerialFace (over COBS) use this codec for framing.

Trait Implementations

impl Clone for TlvCodec

fn clone(&self) -> TlvCodec

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Decoder for TlvCodec

type Item = Bytes

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>, 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 Encoder<Bytes> for TlvCodec

type Error = Error

The type of encoding errors.

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

Encodes a frame into the buffer provided.

impl Copy for TlvCodec