Struct OverlayConfig 

pub struct OverlayConfig {
    pub local_endpoint: SocketAddr,
    pub private_key: String,
    pub public_key: String,
    pub overlay_cidr: String,
    pub cluster_cidr: Option<String>,
    pub peer_discovery_interval: Duration,
    pub uapi_sock_dir: PathBuf,
    pub mtu: u32,
}

Overlay network configuration

Fields

local_endpoint: SocketAddr

Local overlay endpoint (WireGuard protocol)

private_key: String

Private key (x25519)

public_key: String

Public key (derived from private key)

overlay_cidr: String

Overlay network CIDR (supports both IPv4 e.g. “10.0.0.0/8” and IPv6 e.g. “fd00::/48”)

Historically stores the per-node slice / host IP (e.g. 10.200.0.0/28 or 10.200.0.1/32) that the local TUN/Wintun adapter is assigned. It is not the full cluster CIDR — use Self::cluster_cidr for that.

cluster_cidr: Option<String>

Full cluster CIDR (e.g. 10.200.0.0/16).

Used on Windows to install a catch-all host route pointing the entire cluster range at the Wintun adapter so traffic to remote-node container IPs flows through the overlay (HCN auto-installs the more specific local /28 → vSwitch route, and longest-prefix-match routes local traffic to the vSwitch). None on pre-cluster-CIDR configs; callers should fall back to skipping the route install in that case.

peer_discovery_interval: Duration

Peer discovery interval

uapi_sock_dir: PathBuf

Directory containing per-interface WireGuard UAPI sockets (<dir>/<interface_name>.sock). Defaults to /var/run/wireguard on Linux for wg(8) interop; overridden to {data_dir}/run/wireguard by the daemon when running with a non-default --data-dir to keep a test/dev daemon hermetic.

mtu: u32

MTU applied to the overlay tunnel interface.

Defaults to 1420: the standard WireGuard tunnel MTU (1500-byte underlay MTU minus 80 bytes of WireGuard encapsulation overhead). Matches the Windows Wintun default in transport.rs.

Applied to the TUN interface on Linux/macOS at configure time. On Windows, Wintun exposes no per-adapter MTU setter, so this value is advisory there (IP Helper may override it). Lowering it matters when running WireGuard-in-WireGuard — e.g. the overlay riding over another mesh such as netbird — where stacked encapsulation shrinks the usable payload and an over-large MTU causes silent blackholing of oversized packets that can’t be fragmented.

Trait Implementations

impl Clone for OverlayConfig

fn clone(&self) -> OverlayConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OverlayConfig

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

Formats the value using the given formatter.

impl Default for OverlayConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for OverlayConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for OverlayConfig

fn eq(&self, other: &OverlayConfig) -> 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 OverlayConfig

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 OverlayConfig