Struct InterfaceBuilder 

pub struct InterfaceBuilder { /* private fields */ }

Builder for Interface.

Implementations

impl InterfaceBuilder

pub fn address<VALUE: Into<Vec<IpNet>>>(&mut self, value: VALUE) -> &mut Self

Interface’s address.

/32 and /128 IP networks will be generated as regular ips (f.e. 1.2.3.4/32 -> 1.2.3.4)

You can also use InterfaceBuilder::add_network() to add a single network and InterfaceBuilder::add_address() to add a single address.

Wireguard docs

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

Port to listen for incoming VPN connections.

Wireguard conf

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

Node’s private key.

Wireguard conf

pub fn dns<VALUE: Into<Vec<String>>>(&mut self, value: VALUE) -> &mut Self

The DNS servers to announce to VPN clients via DHCP.

Wireguard docs

pub fn endpoint<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self

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

pub fn table(&mut self, value: Table) -> &mut Self

Routing table to use for the WireGuard routes.

See Table for special values.

Wireguard docs

pub fn mtu(&mut self, value: usize) -> &mut Self

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

Wireguard docs

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

Available on crate feature amneziawg only.

AmneziaWG obfuscation values.

AmneziaWG Docs

pub fn pre_up<VALUE: Into<Vec<String>>>(&mut self, value: VALUE) -> &mut Self

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

Wireguard docs

pub fn pre_down<VALUE: Into<Vec<String>>>(&mut self, value: VALUE) -> &mut Self

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

Wireguard docs

pub fn post_up<VALUE: Into<Vec<String>>>(&mut self, value: VALUE) -> &mut Self

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

Wireguard docs

pub fn post_down<VALUE: Into<Vec<String>>>(&mut self, value: VALUE) -> &mut Self

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

Wireguard docs

pub fn peers<VALUE: Into<Vec<Peer>>>(&mut self, value: VALUE) -> &mut Self

Peers.

Create them using PeerBuilder or Interface::to_peer method.

Wireguard docs

impl InterfaceBuilder

pub fn new() -> Self

Create new InterfaceBuilder.

let interface = InterfaceBuilder::new()
    .address([as_ipnet!("10.0.0.1/24")])
    // <snip>
    .build();

pub fn add_network<T: Into<IpNet>>(&mut self, value: T) -> &mut Self

Adds IP Network to Address = ... field.

value is Into<IpNet>, which means that it can be either ipnet::IpNet or std::net::IpAddr.

Example

use wireguard_conf::{as_ipnet, prelude::*};

let interface = InterfaceBuilder::new()
    .add_network(as_ipnet!("1.2.3.4/16"))
    .add_network(as_ipnet!("fd00:DEAD:BEEF::1/48"))
    .build();

assert_eq!(
    interface.address,
    vec![
        as_ipnet!("1.2.3.4/16"),
        as_ipnet!("fd00:DEAD:BEEF::1/48")
    ]
);

pub fn add_address<T: Into<IpAddr>>(&mut self, value: T) -> &mut Self

Adds IP address to Address = ... field.

value is Into<IpAddr>, which means that it can be either std::net::Ipv4Addr or std::net::Ipv6Addr.

Example

use wireguard_conf::{as_ipaddr, as_ipnet, prelude::*};

let interface = InterfaceBuilder::new()
    .add_address(as_ipaddr!("1.2.3.4"))
    .add_address(as_ipaddr!("fd00::1"))
    .build();

// /32 and /128 are added automatically
assert_eq!(
    interface.address,
    vec![
        as_ipnet!("1.2.3.4/32"),
        as_ipnet!("fd00::1/128"),
    ]
);

pub fn build(&self) -> Interface

Builds an Interface.

Trait Implementations

impl Clone for InterfaceBuilder

fn clone(&self) -> InterfaceBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for InterfaceBuilder

fn default() -> Self

Returns the “default value” for a type.