Struct Interface 

pub struct Interface { /* private fields */ }

A handle to a WireGuard interface

Cloning returns a new handle to the same interface.

Implementations

impl Interface

pub fn new(config: Config) -> Result<Self, Error>

Create a new interface

pub fn address(&self) -> Address

Local address of the interface within the WireGuard network

pub fn options(&self) -> &Options

Advanced options for the interface

pub fn close(&self)

Request that the interface be closed

All sockets created by the interface will be closed, and any attempt to send or receive data using them will result in an error. Once all remaining queued packets have been sent, the interface will enter the closed state.

pub fn closed(&self) -> Closed<'_>

Returns a future that resolves once the interface is in the closed state

See close for more information.

pub fn is_closed(&self) -> bool

Whether the interface is in the closed state

See close for more information.

pub fn new_with(config: Config, options: Options) -> Result<Self, Error>

Create a new interface with advanced options

pub async fn add_peer(&self, config: Peer) -> Result<(), Error>

Dynamically add a new peer to the interface. The peer will only become available once the returned future resolves.

pub async fn remove_peer(&self, key: &PublicKey) -> Result<bool, Error>

Removes a peer from the interface. Returns whether the peer existed.

Trait Implementations

impl Clone for Interface

fn clone(&self) -> Interface

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Interface

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

Formats the value using the given formatter.

impl<'a> ToInterface for &'a Interface

async fn to_interface(self) -> Result<Interface, Error>

impl<'a> ToInterface for &'a mut Interface

async fn to_interface(self) -> Result<Interface, Error>

impl ToInterface for Interface

async fn to_interface(self) -> Result<Interface, Error>