Struct Maintenance 

pub struct Maintenance {
    pub retry_after_secs: Option<u64>,
    pub message: Option<String>,
}

Route maintenance mode (DW-041): a per-route availability state that short-circuits every matched request with a gateway-generated 503.

Frozen semantics (enforcement lives in dataplane::proxy):

• Checked IMMEDIATELY after route resolution, BEFORE the route’s request limits: maintenance is a statement about the route’s availability, not about any one request’s shape, so every matched request gets the same 503 + Retry-After answer (an over-limit request during maintenance is told “we’re down”, not “your headers are too big” — fixing the headers would still leave it refused).
• The response is 503 with Retry-After: <retry_after_secs> (a whole-seconds delay-suggestion, NOT a promise of recovery) and the uniform JSON error envelope; message replaces the envelope’s default human text (it never leaks upstream internals — it is operator-authored).
• CORS: an actual (non-preflight) request on a CORS-configured route gets the policy’s actual-response headers on the 503, so a browser client can READ the maintenance envelope cross-origin. A CORS PREFLIGHT is exempt: it still answers 204 exactly as without maintenance. The preflight is a Fetch-protocol handshake about the GATEWAY’s cross-origin policy, answered from static config and sent without credentials — failing it would surface in the browser as an opaque CORS error and hide the very 503 the operator wants clients to see on the subsequent actual request.
• Reserved paths (/healthz, /readyz, /metrics) never match a route, so probes and scrapes keep answering through maintenance — an orchestrator must not restart a deliberately idling gateway.
• Unrouted traffic is unaffected (maintenance is per-route; a 404 stays a 404).

Fields

retry_after_secs: Option<u64>

Retry-After value, in whole seconds, sent with the 503. Absent: 60 (one minute — long enough to shed load, short enough that a client polling for recovery notices the route return). Validation rejects 0 (it would invite an immediate retry stampede against a route the operator just took down).

message: Option<String>

Human-readable text for the error envelope’s message field. Absent: “route under maintenance”. Validation rejects an empty/whitespace string (omit the field for the default).

Implementations

impl Maintenance

pub fn retry_after(&self) -> u64

The Retry-After seconds to send (the configured value or the default; validation has rejected 0, so this is always >= 1).

pub fn message(&self) -> &str

The envelope message text (the configured value or the default).

Trait Implementations

impl Clone for Maintenance

fn clone(&self) -> Maintenance

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Maintenance

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Maintenance

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for Maintenance

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

The name of the generated JSON Schema.

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

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for Maintenance

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

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 Maintenance