Skip to main content

EdgeConfig

Struct EdgeConfig 

Source
pub struct EdgeConfig {
    pub enabled: bool,
    pub role: EdgeRole,
    pub home_url: String,
    pub auth_token: String,
    pub allow_insecure_home_url: bool,
    pub default_ttl_secs: u64,
    pub max_entries: usize,
    pub max_edges: usize,
    pub liveness_window_secs: u64,
    pub subscribe_gc_secs: u64,
    pub region: String,
    pub edge_id: String,
}
Expand description

Edge-mode runtime config ([edge] in proxy.toml). Every field is serde-defaulted so a partial — or absent — section parses on any build; the machinery only runs when enabled and the edge-proxy feature is compiled in (validate() rejects the former without the latter).

Fields§

§enabled: bool

Master switch. Off (default) = the edge cache/registry wiring is skipped entirely and this section is inert.

§role: EdgeRole

“edge” or “home” mode. Edges forward writes + cache reads; home is authoritative.

§home_url: String

For edge: home proxy admin URL (e.g. “https://proxy.home.svc:9090”). Empty when role = home.

§auth_token: String

For edge: bearer token presented to home’s admin API for the invalidation subscription. Empty when role = home. When set, home_url must be https:// (or allow_insecure_home_url opted into) — the token is the home’s ADMIN bearer and must not cross an untrusted network in cleartext.

§allow_insecure_home_url: bool

For edge: allow presenting auth_token to a plain-http home_url. Only for provably private links (VPN/WireGuard/ service mesh, loopback dev setups) — mirrors admin_allow_insecure on the home side.

§default_ttl_secs: u64

Default TTL in seconds applied to cache entries when the home doesn’t supply one explicitly. Reads expire after this elapses. (Integer seconds, like every other *_secs duration knob.)

§max_entries: usize

Maximum cache entries before LRU eviction kicks in.

§max_edges: usize

For home: maximum simultaneous registered edge nodes.

§liveness_window_secs: u64

For home: edges not seen within this window are pruned from the registry by the GC sweep (a pruned edge just re-registers on its next reconnect). Liveness is refreshed by successful SSE heartbeat writes (every 15s), so keep this comfortably above ~45s (3 heartbeats) or healthy-but-idle edges will churn.

§subscribe_gc_secs: u64

For home: cadence of the registry GC sweep.

§region: String

For edge: region label reported when subscribing to the home (shows up in the home’s /api/edge listing).

§edge_id: String

For edge: stable id this proxy registers under. Empty (default) = the runtime falls back to “edge-”.

Implementations§

Source§

impl EdgeConfig

Source

pub fn default_ttl(&self) -> Duration

The entry TTL as a Duration (config carries integer seconds, matching every other *_secs knob).

Trait Implementations§

Source§

impl Clone for EdgeConfig

Source§

fn clone(&self) -> EdgeConfig

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for EdgeConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for EdgeConfig

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

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

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for EdgeConfig

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for EdgeConfig

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for EdgeConfig

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more