Struct Peer

pub struct Peer {
    pub endpoint: Option<String>,
    pub allowed_ips: Vec<Ipv4Net>,
    pub key: Either<PrivateKey, PublicKey>,
    pub amnezia_settings: Option<AmneziaSettings>,
}

Struct, that represents [Peer] section in configuration.

Wireguard docs

Fields

endpoint: Option<String>

Peer’s endpoint.

allowed_ips: Vec<Ipv4Net>

Peer’s allowed IPs.

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.

amnezia_settings: Option<AmneziaSettings>

Available on crate feature amneziawg only.

Implementations

impl Peer

pub fn to_interface(&self, interface: &Interface) -> WireguardResult<Interface>

Get Peer’s Interface.

Pass server’s interface to interface argument.

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 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.