Struct Peer 

pub struct Peer {
    pub endpoint: Option<String>,
    pub allowed_ips: Vec<IpNet>,
    pub persistent_keepalive: u16,
    pub key: Either<PrivateKey, PublicKey>,
    pub preshared_key: Option<PresharedKey>,
}

Struct, that represents [Peer] section in configuration.

Wireguard docs

Fields

endpoint: Option<String>

Peer’s endpoint.

Wireguard Docs

allowed_ips: Vec<IpNet>

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

persistent_keepalive: u16

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

key: Either<PrivateKey, PublicKey>

Peer’s key.

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

preshared_key: Option<PresharedKey>

Peer’s preshared-key.

Implementations

impl Peer

pub fn builder() -> PeerBuilder

Create new PeerBuilder. Alias for PeerBuilder::new().

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

impl Peer

pub fn to_interface( &self, server_interface: &Interface, options: ToInterfaceOptions, ) -> WireguardResult<Interface>

Generate Interface from client’s Peer and server’s Interface.

options

Errors

• WireguardError::NoPrivateKeyProvided – peer don’t have private key. You need to provide PrivateKey for creating interfaces from peers.
• WireguardError::NoAssignedIP – no assigned ip found. This means that your peer doesn’t have allowed ip, that is in interface’s addresses network.

Trait Implementations

impl Clone for Peer

fn clone(&self) -> Peer

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Peer

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Peer

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Peer

Implements fmt::Display for exporting peer.

Note

It exports only [Peer] ... part. To export full interface, use Peer::to_interface() and then .to_string()

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

Formats the value using the given formatter.

impl PartialEq for Peer

fn eq(&self, other: &Peer) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Peer

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Peer