Struct Device

pub struct Device {
    pub name: InterfaceName,
    pub public_key: Option<Key>,
    pub private_key: Option<Key>,
    pub fwmark: Option<u32>,
    pub listen_port: Option<u16>,
    pub peers: Vec<PeerInfo>,
    pub linked_name: Option<String>,
    pub backend: Backend,
    /* private fields */
}

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: InterfaceName

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

linked_name: Option<String>

The associated “real name” of the interface (ex. “utun8” on macOS).

backend: Backend

The backend the device exists on (userspace or kernel).

Implementations

impl Device

pub fn list(backend: Backend) -> Result<Vec<InterfaceName>, Error>

Enumerates all WireGuard interfaces currently present in the system, both with kernel and userspace backends.

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

Examples found in repository

examples/enumerate.rs (line 9)

fn main() {
    let devices = Device::list(BACKEND).unwrap();
    println!("{devices:?}");
}

pub fn get(name: &InterfaceName, backend: Backend) -> Result<Self, Error>

pub fn delete(self) -> Result<(), Error>

Trait Implementations

impl Clone for Device

fn clone(&self) -> Device

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Device

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

Formats the value using the given formatter.

impl PartialEq for Device

fn eq(&self, other: &Device) -> 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<'a> TryFrom<&'a [WgDeviceAttrs]> for Device

type Error = Error

The type returned in the event of a conversion error.

fn try_from(nlas: &'a [WgDeviceAttrs]) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for Device

impl StructuralPartialEq for Device