Struct InterfaceBuilder

pub struct InterfaceBuilder { /* private fields */ }

Builder, that used for creating Interfaces.

Examples

use wireguard_conf::prelude::*;

let server_private_key = PrivateKey::random();

let interface = InterfaceBuilder::new()
    .address("10.0.0.1/24".parse().unwrap())
    .listen_port(6969)
    .private_key(server_private_key.clone())
    .set_dns(vec!["8.8.8.8".to_string(), "8.8.4.4".to_string()])
    .endpoint("vpn.example.com".to_string())
    // .add_peer(some_peer)
    .build();

assert_eq!(interface.address, "10.0.0.1/24".parse().unwrap());
assert_eq!(interface.listen_port, Some(6969));
assert_eq!(interface.private_key, server_private_key);
assert_eq!(interface.dns, vec!["8.8.8.8", "8.8.4.4"]);
assert_eq!(interface.endpoint, Some("vpn.example.com".to_string()));

Implementations

impl InterfaceBuilder

pub fn new() -> InterfaceBuilder

pub fn address(self, address: Ipv4Net) -> Self

Set the address.

Wireguard Docs

pub fn listen_port(self, listen_port: u16) -> Self

Set the listen port.

Wireguard Docs

pub fn private_key(self, private_key: PrivateKey) -> Self

Set the private key.

Wireguard Docs

pub fn set_dns(self, dns: Vec<String>) -> Self

Set the DNS servers array.

Wireguard Docs

pub fn add_dns(self, dns: String) -> Self

Add DNS server.

Wireguard Docs

pub fn endpoint(self, endpoint: String) -> Self

Set the endpoint.

Note

• [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

pub fn set_table(self, value: Table) -> Self

Set routing table. See Table for special values.

Wireguard docs

pub fn set_mtu(self, value: usize) -> Self

Set Maximum Transmission Unit (MTU, aka packet/frame size).

Wireguard docs

pub fn set_peers(self, peers: Vec<Peer>) -> Self

Set the Peers array.

Wireguard Docs

pub fn add_peer(self, peer: Peer) -> Self

Add peer.

Wireguard Docs

pub fn amnezia_settings(self, amnezia_settings: AmneziaSettings) -> Self

Available on crate feature amneziawg only.

Sets AmneziaWG obfuscation values.

AmneziaWG Docs

pub fn set_pre_up(self, snippets: Vec<String>) -> Self

Set commands, that will be executed before the interface is brought up.

Wireguard docs

pub fn add_pre_up(self, snippet: String) -> Self

Add command, that will be executed before the interface is brought up.

Wireguard docs

pub fn set_pre_down(self, snippets: Vec<String>) -> Self

Set commands, that will be executed before the interface is brought down.

Wireguard docs

pub fn add_pre_down(self, snippet: String) -> Self

Add command, that will be executed before the interface is brought down.

Wireguard docs

pub fn set_post_up(self, snippets: Vec<String>) -> Self

Set commands, that will be executed after the interface is brought up.

Wireguard docs

pub fn add_post_up(self, snippet: String) -> Self

Add command, that will be executed after the interface is brought up.

Wireguard docs

pub fn set_post_down(self, snippets: Vec<String>) -> Self

Set commands, that will be executed after the interface is brought down.

Wireguard docs

pub fn add_post_down(self, snippet: String) -> Self

Add command, that will be executed after the interface is brought down.

Wireguard docs

pub fn build(self) -> Interface

Creates Interface.

Trait Implementations

impl Default for InterfaceBuilder

fn default() -> InterfaceBuilder

Returns the “default value” for a type.