Struct EdgeConfig 

pub struct EdgeConfig {
    pub version: u32,
    pub name: String,
    pub overlay_ip: IpAddr,
    pub prefix_len: u8,
    pub private_key: String,
    pub public_key: String,
    pub peers: Vec<PeerSpec>,
    pub dns_server: Option<IpAddr>,
    pub dns_domain: Option<String>,
    pub expires_at_unix: u64,
}

Portable artifact for a minted edge peer (OverlaydRequest::MintEdgePeer → OverlaydResponse::EdgeConfig): everything a short-lived unprivileged WireGuard edge process needs to join the overlay. Minted peers die with overlayd — provisioners re-mint rather than persist and reuse a config.

Fields

version: u32

Always EDGE_CONFIG_VERSION for configs minted by this build; EdgeConfig::from_token rejects anything else.

name: String

The caller-chosen handle the peer was minted under.

overlay_ip: IpAddr

The edge peer’s allocated overlay address.

prefix_len: u8

Prefix length of the overlay network (interface address + on-link route).

private_key: String

Base64 WireGuard private key for the edge peer’s device.

public_key: String

Base64 WireGuard public key matching private_key (registered in the mesh by overlayd; echoed for the caller’s bookkeeping).

peers: Vec<PeerSpec>

The peers the edge should configure (the minting node, at least). Each PeerSpec::allowed_ips is a comma-separated CIDR list by the established convention — vzagent splits on ','.

dns_server: Option<IpAddr>

Overlay DNS resolver IP for the edge peer, if any.

dns_domain: Option<String>

Overlay DNS search domain, if any.

expires_at_unix: u64

Unix-seconds when the peer expires and is swept from the mesh.

Implementations

impl EdgeConfig

pub fn to_token(&self) -> String

Encode the config as a single zledge1.-prefixed URL-safe-base64 (no padding) string of its compact-JSON form, suitable for CLI flags / env vars (the prefix-versioned CLI-string idiom, cf. WorkerBootstrapToken::to_cli_string in zlayer-secrets).

Panics

Never in practice: EdgeConfig JSON-serializes infallibly (no non-string map keys, no fallible Serialize impls).

pub fn from_token(token: &str) -> Result<EdgeConfig, EdgeTokenError>

Decode a token previously produced by Self::to_token.

Errors

Returns EdgeTokenError::BadPrefix when the zledge1. prefix is missing, EdgeTokenError::Decode / EdgeTokenError::Parse on base64 / JSON failure, and EdgeTokenError::UnsupportedVersion when the payload’s version is not EDGE_CONFIG_VERSION.

Trait Implementations

impl Clone for EdgeConfig

fn clone(&self) -> EdgeConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EdgeConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EdgeConfig

fn deserialize<__D>( __deserializer: __D, ) -> Result<EdgeConfig, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for EdgeConfig

impl PartialEq for EdgeConfig

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for EdgeConfig

impl ToSchema for EdgeConfig

fn name() -> Cow<'static, str>

Return name of the schema.

fn schemas(schemas: &mut Vec<(String, RefOr<Schema>)>)

Implement reference utoipa::openapi::schema::Schemas for this type.