Struct PeerBuilder 

pub struct PeerBuilder { /* private fields */ }

Builder for Peer.

Implementations

impl PeerBuilder

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

Peer’s endpoint.

Wireguard Docs

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

Peer’s allowed IPs.

• */32 and */128 ipnets will be generated as regular ips (f.e. 1.2.3.4/32 -> 1.2.3.4)

Wireguard Docs

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

Peer’s persistent keepalive.

Represents in seconds how often to send an authenticated empty packet to the peer, for the purpose of keeping a stateful firewall or NAT mapping valid persistently.

Setting this value to 0 omits it in config.

Wireguard docs

pub fn key(&mut self, value: Either<PrivateKey, PublicKey>) -> &mut Self

Peer’s key.

If PrivateKey is provided, then peer can be exported to interface & full config. Otherwise only to peer section of config.

pub fn preshared_key(&mut self, value: PresharedKey) -> &mut Self

Peer’s preshared-key.

impl PeerBuilder

pub fn new() -> Self

Create new PeerBuilder.

let interface = PeerBuilder::new()
    .allowed_ips([as_ipnet!("0.0.0.0/0")])
    // <snip>
    .build();

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

Sets private key.

Shorthand for .key(Either::Left(value)).

pub fn public_key(&mut self, value: PublicKey) -> &mut Self

Sets public key.

Shorthand for .key(Either::Right(value)).

pub fn build(&self) -> Peer

Builds an Interface.

Trait Implementations

impl Clone for PeerBuilder

fn clone(&self) -> PeerBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for PeerBuilder

fn default() -> Self

Returns the “default value” for a type.