Struct Interface

pub struct Interface {

    pub address: Ipv4Net,
    pub listen_port: Option<u16>,
    pub private_key: PrivateKey,
    pub dns: Vec<String>,
    pub endpoint: Option<String>,
    pub table: Option<Table>,
    pub mtu: Option<usize>,
    pub amnezia_settings: Option<AmneziaSettings>,
    pub pre_up: Vec<String>,
    pub pre_down: Vec<String>,
    pub post_up: Vec<String>,
    pub post_down: Vec<String>,
    pub peers: Vec<Peer>,
}

Struct, that represents complete configuration (contains both [Interface] and [Peer] sections).

Use InterfaceBuilder to create interface.

Wireguard docs

Fields

address: Ipv4Net

Interface’s address.

Wireguard docs

listen_port: Option<u16>

Port to listen for incoming VPN connections.

Wireguard conf

private_key: PrivateKey

Node’s private key.

Wireguard conf

dns: Vec<String>

The DNS servers to announce to VPN clients via DHCP.

Wireguard docs

endpoint: Option<String>

Endpoint.

• [Interface] section will have # Name = <endpoint> comment at the top.
• Exported Peer (via Interface::to_peer) will have this endpoint.

Wireguard Docs for # Name; Wireguard Docs for endpoint

table: Option<Table>

Routing table to use for the WireGuard routes.

See Table for special values.

Wireguard docs

mtu: Option<usize>

Maximum Transmission Unit (MTU, aka packet/frame size) to use when connecting to the peer.

Wireguard docs

amnezia_settings: Option<AmneziaSettings>

Available on crate feature amneziawg only.

AmneziaWG obfuscation values.

AmneziaWG Docs

pre_up: Vec<String>

Commands, that will be executed before the interface is brought up

Wireguard docs

pre_down: Vec<String>

Commands, that will be executed before the interface is brought down

Wireguard docs

post_up: Vec<String>

Commands, that will be executed after the interface is brought up

Wireguard docs

post_down: Vec<String>

Commands, that will be executed after the interface is brought down

Wireguard docs

peers: Vec<Peer>

Peers.

Create them using PeerBuilder or Interface::to_peer method.

Wireguard docs

Implementations

impl Interface

pub fn to_peer(&self) -> Peer

Get Peer from interface.

Examples

// Create server node
let mut server = InterfaceBuilder::new()
    // <snip>
    .build();

// Create client node, and add server to client's peers
let client = InterfaceBuilder::new()
    // <snip>
    .add_peer(server.to_peer()) // convert `Interface` to `Peer` using `.to_peer()` method.
    .build();

// Add client to server's peers
server.peers.push(client.to_peer());

println!("Server config:\n{server}");
println!("Client config:\n{client}");

Trait Implementations

impl Clone for Interface

fn clone(&self) -> Interface

Returns a copy 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 Display for Interface

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

Formats the value using the given formatter.