Skip to main content

VersionInfo

Struct VersionInfo 

Source
pub struct VersionInfo { /* private fields */ }
Expand description

Parsed output from the version command’s multi-line response.

The response from OpenVPN looks like:

OpenVPN Version: OpenVPN 2.6.9 x86_64-pc-linux-gnu [SSL (OpenSSL)] ...
Management Interface Version: 5
END

Note: OpenVPN ≥ 2.6.16 shortened the header to Management Version: 5 (without “Interface”). Both forms are accepted.

This struct extracts the management interface version (which is the field most consumers need for feature-gating) and keeps the raw lines for anything else.

§Examples

use openvpn_mgmt_codec::VersionInfo;

let lines = vec![
    "OpenVPN Version: OpenVPN 2.6.9 x86_64-pc-linux-gnu [SSL (OpenSSL)] [LZO] [LZ4] [EPOLL] [MH/PKTINFO] [AEAD]".to_string(),
    "Management Interface Version: 5".to_string(),
];
let info = VersionInfo::parse(&lines);
assert_eq!(info.management_version(), Some(5));
assert!(info.openvpn_version_line().unwrap().contains("2.6.9"));

Implementations§

Source§

impl VersionInfo

Source

pub fn parse(lines: &[String]) -> Self

Parse a version command’s multi-line response into structured data.

Lines that don’t match known prefixes are preserved in raw_lines for forward compatibility.

Source

pub fn management_version(&self) -> Option<u32>

The management interface protocol version (e.g. 5).

Returns None if the line was missing or unparseable. Use this to gate features: for instance, client-pending-auth requires management version >= 5 (OpenVPN 2.5+).

Source

pub fn openvpn_version_line(&self) -> Option<&str>

The full OpenVPN Version: line (e.g. "OpenVPN Version: OpenVPN 2.6.9 ...").

Source

pub fn raw_lines(&self) -> &[String]

All raw lines from the response, for anything not explicitly parsed.

Trait Implementations§

Source§

impl Clone for VersionInfo

Source§

fn clone(&self) -> VersionInfo

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for VersionInfo

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for VersionInfo

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for VersionInfo

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Eq for VersionInfo

Source§

impl StructuralPartialEq for VersionInfo

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more