Enum OvpnMessage 

pub enum OvpnMessage {
    Success(String),
    Error(String),
    MultiLine(Vec<String>),
    Pkcs11IdEntry {
        index: String,
        id: String,
        blob: String,
    },
    Notification(Notification),
    Info(String),
    PasswordPrompt,
    Unrecognized {
        line: String,
        kind: UnrecognizedKind,
    },
}

A fully decoded message from the OpenVPN management interface.

Variants

Success(String)

A success response: SUCCESS: [text].

Error(String)

An error response: ERROR: [text].

MultiLine(Vec<String>)

A multi-line response block (from status, version, help, etc.). The terminating END line is consumed but not included.

Pkcs11IdEntry

Parsed response from >PKCS11ID-ENTRY: notification (sent by pkcs11-id-get). Wire: >PKCS11ID-ENTRY:'index', ID:'id', BLOB:'blob'

Fields

index: String

Certificate index.

id: String

PKCS#11 identifier.

blob: String

Base64-encoded certificate blob.

Notification(Notification)

A real-time notification, either single-line or accumulated multi-line.

Info(String)

The >INFO: banner sent when the management socket first connects. Technically a notification, but surfaced separately since it’s always the first thing you see and is useful for version detection.

PasswordPrompt

Management interface password prompt. Sent when --management is configured with a password file. The client must respond with the password (via crate::OvpnCommand::ManagementPassword) before any commands are accepted.

Unrecognized

A line that could not be classified into any known message type. Contains the raw line and a description of what went wrong.

Fields

line: String

The raw line that could not be parsed.

kind: UnrecognizedKind

Why the line was not recognized.

Trait Implementations

impl Clone for OvpnMessage

fn clone(&self) -> OvpnMessage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OvpnMessage

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

Formats the value using the given formatter.

impl From<OvpnMessage> for ManagementEvent

fn from(msg: OvpnMessage) -> Self

Converts to this type from the input type.

impl PartialEq for OvpnMessage

fn eq(&self, other: &OvpnMessage) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for OvpnMessage

impl StructuralPartialEq for OvpnMessage