Struct PeerBuilder

pub struct PeerBuilder { /* private fields */ }

Builder, that used for creating Peers.

Examples

use wireguard_conf::prelude::*;
use either::Either;

let client_private_key = PrivateKey::random();

let peer = PeerBuilder::new()
    .endpoint("public.client.example.com".to_string())
    .add_allowed_ip("10.0.0.2/32".parse().unwrap())
    .private_key(client_private_key.clone())
    // if you don't want to generate interface from peer, you can provide public key
    // instead of private_key:
    //  .public_key(client_public_key)
    .build();

assert_eq!(peer.endpoint, Some("public.client.example.com".to_string()));
assert_eq!(peer.allowed_ips, vec!["10.0.0.2/32".parse().unwrap()]);
assert_eq!(peer.key, Either::Left(client_private_key));

Implementations

impl PeerBuilder

pub fn new() -> PeerBuilder

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

Sets endpoint.

Wireguard Docs

pub fn set_allowed_ips(self, ip: Vec<Ipv4Net>) -> PeerBuilder

Sets Allowed IPs array.

Wireguard Docs

pub fn add_allowed_ip(self, ip: Ipv4Net) -> PeerBuilder

Adds allowed IP.

Wireguard Docs

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

Sets private key.

Note

If you set private key (instead of public key), you can generate Interface from Peer (see [Peer::as_interface()]).

Wireguard Docs

pub fn public_key(self, public_key: PublicKey) -> PeerBuilder

Sets public key.

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 build(self) -> Peer

Creates Peer.

Trait Implementations

impl Default for PeerBuilder

fn default() -> PeerBuilder

Returns the “default value” for a type.