Struct OvpnCodec 

pub struct OvpnCodec { /* private fields */ }

Tokio codec for the OpenVPN management interface.

The encoder serializes typed OvpnCommand values into correct wire-format bytes, including proper escaping and multi-line block framing. The decoder uses command-tracking state to correctly distinguish single-line from multi-line responses, and accumulates multi-line >CLIENT: notifications into a single OvpnMessage before emitting them.

Implementations

impl OvpnCodec

pub fn new() -> Self

Create a new codec with default state, ready to encode commands and decode responses.

Trait Implementations

impl Decoder for OvpnCodec

type Item = OvpnMessage

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 Default for OvpnCodec

fn default() -> Self

Returns the “default value” for a type.

impl Encoder<OvpnCommand> for OvpnCodec

type Error = Error

The type of encoding errors.

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

Encodes a frame into the buffer provided.