Struct OopServeOptions 

#[non_exhaustive]
pub struct OopServeOptions {

    pub gear_name: String,
    pub instance_id: String,
    pub version: Option<String>,
    pub advertise_uri: String,
    pub listen_addr: SocketAddr,
    pub probe_bind_addr: Option<SocketAddr>,
    pub drain_timeout: Duration,
    pub heartbeat_interval: Duration,
    pub healthcheck_timeout: Duration,
    pub directory: Arc<dyn DirectoryClient>,
    pub bearer_authenticator: Option<DynBearerAuthenticator>,
    pub internal_authenticator: Option<DynInternalAuthenticator>,
    pub labels: BTreeMap<String, String>,
}

Configuration and collaborators for the OoP HTTP runtime, assembled by the bootstrap layer and consumed by HostRuntime’s OoP serving path.

#[non_exhaustive] so new fields (like labels) stay additive: the type is built by the bootstrap layer, never struct-literal-constructed from another crate, so adding a field never breaks a downstream constructor. (A Default impl is intentionally not provided — the directory collaborator is a required dependency with no meaningful default.)

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

gear_name: String

Logical gear name (used for registration + OpenAPI title).

instance_id: String

Process instance id (used for registration/deregistration).

version: Option<String>

Optional gear version (used for registration + OpenAPI version).

advertise_uri: String

Base URL other services use to reach this instance’s REST endpoint (e.g. http://billing.default.svc.cluster.local:8080). Registered with DirectoryService as the instance’s rest_endpoint.

listen_addr: SocketAddr

Address the main HTTP server binds to (gear routes + probes).

probe_bind_addr: Option<SocketAddr>

Optional separate address for probe endpoints (sidecar port). When set, probes are served here and on the main listener.

drain_timeout: Duration

Maximum time to wait for in-flight requests to drain on shutdown.

heartbeat_interval: Duration

Interval between DirectoryService heartbeats. The single presence task (presence_loop) sends a heartbeat every interval to keep the instance Healthy/routable and avoid heartbeat-timeout eviction. The presence loop clamps this to a 1s minimum.

healthcheck_timeout: Duration

Per-check timeout for readiness healthchecks (/readyz). A gear’s Healthcheck that exceeds this is reported Unhealthy. Mirrors the api-gateway healthcheck_timeout_ms.

directory: Arc<dyn DirectoryClient>

Directory client used for self-registration and dependency resolution.

bearer_authenticator: Option<DynBearerAuthenticator>

Tenant-plane authenticator; when Some, security_context_middleware is installed on gear routes.

internal_authenticator: Option<DynInternalAuthenticator>

Platform-plane authenticator; when Some, internal_auth_middleware is installed on gear routes (runs before the tenant plane).

labels: BTreeMap<String, String>

Stable addressing labels (k8s matchLabels style) advertised with this instance’s directory registration for label-based selection.

Trait Implementations

impl Debug for OopServeOptions

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

Formats the value using the given formatter.