Struct TunPacketCodec

pub struct TunPacketCodec(/* private fields */);

A TUN packet Encoder/Decoder.

Implementations

impl TunPacketCodec

pub fn new(mtu: usize) -> TunPacketCodec

Create a new TunPacketCodec specifying whether the underlying tunnel Device has enabled the packet information header.

Trait Implementations

impl Debug for TunPacketCodec

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

Formats the value using the given formatter.

impl Decoder for TunPacketCodec

type Item = Vec<u8>

The type of decoded frames.

type Error = Error

The type of unrecoverable frame decoding errors.

fn decode( &mut self, buf: &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 Default for TunPacketCodec

fn default() -> TunPacketCodec

Returns the “default value” for a type.

impl Encoder<Vec<u8>> for TunPacketCodec

type Error = Error

The type of encoding errors.

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

Encodes a frame into the buffer provided.