Struct DeviceInfo

Source
pub struct DeviceInfo {
    pub name: String,
    pub public_key: Option<Key>,
    pub private_key: Option<Key>,
    pub fwmark: Option<u32>,
    pub listen_port: Option<u16>,
    pub peers: Vec<PeerInfo>,
    /* private fields */
}
Expand description

Represents all available information about a WireGuard device (interface).

This struct contains the current configuration of the device and the current configuration and state of all of its peers. The peer statistics are retrieved once at construction time, and need to be updated manually by calling get_by_name.

Fields§

§name: String

The interface name of this device

§public_key: Option<Key>

The public encryption key of this interface (if present)

§private_key: Option<Key>

The private encryption key of this interface (if present)

§fwmark: Option<u32>

The fwmark of this interface

§listen_port: Option<u16>

The port to listen for incoming connections on

§peers: Vec<PeerInfo>

The list of all registered peers and their information

Implementations§

Source§

impl DeviceInfo

Source

pub fn enumerate() -> Result<Vec<String>, Error>

Enumerates all WireGuard interfaces currently present in the system and returns their names.

You can use get_by_name to retrieve more detailed information on each interface.

§Example
for dev in DeviceInfo::enumerate()? {
    println!("{:#?}", DeviceInfo::get_by_name(&dev));
}
Source

pub fn get_by_name(name: &str) -> Result<Self, Error>

Loads all available information on a given interface (by name) from the kernel.

Actually doing this probably requires root privileges.

§Example
for dev in DeviceInfo::enumerate()? {
    if let Ok(dev) = DeviceInfo::get_by_name(&dev) {
         println!(
            "Successfully loaded interface {}; public key: {:?}",
            dev.name, dev.public_key.map(|k| k.to_base64())
         )
    }
}

Trait Implementations§

Source§

impl Clone for DeviceInfo

Source§

fn clone(&self) -> DeviceInfo

Returns a copy 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 DeviceInfo

Source§

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

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

impl<'a> From<&'a wg_device> for DeviceInfo

Source§

fn from(raw: &wg_device) -> DeviceInfo

Converts to this type from the input type.
Source§

impl PartialEq for DeviceInfo

Source§

fn eq(&self, other: &DeviceInfo) -> 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 DeviceInfo

Source§

impl StructuralPartialEq for DeviceInfo

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, dst: *mut u8)

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

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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, 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.