Struct FrameDecoder 

pub struct FrameDecoder { /* private fields */ }

A low-level decoder that splits the byte stream into Frame values.

This decoder classifies each line purely from its content — it does not track which command was sent. Multi-line response accumulation (Line/End grouping) is left to higher layers.

>CLIENT:ENV accumulation is handled here because the protocol guarantees atomicity for that block.

Example

use bytes::BytesMut;
use tokio_util::codec::Decoder;
use openvpn_mgmt_frame::{Frame, FrameDecoder};

let mut decoder = FrameDecoder::new();
let mut buf = BytesMut::from(">INFO:OpenVPN Management Interface\n");

// The first >INFO: line is emitted as Frame::Info (the connection banner).
assert_eq!(
    decoder.decode(&mut buf).unwrap(),
    Some(Frame::Info("OpenVPN Management Interface".to_string())),
);

Implementations

impl FrameDecoder

pub fn new() -> Self

Create a new frame decoder.

pub fn with_max_client_env_entries(self, limit: AccumulationLimit) -> Self

Set the maximum ENV entries for >CLIENT: notifications.

Trait Implementations

impl Debug for FrameDecoder

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

Formats the value using the given formatter.

impl Decoder for FrameDecoder

type Item = Frame

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 FrameDecoder

fn default() -> Self

Returns the “default value” for a type.