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. Construct via OopServeOptions::new + the with_* builders rather than a struct literal, exactly as RunOptions is built: the five arguments to new are the fields with no meaningful default, and everything else defaults to the same values the bootstrap config layer uses. (A Default impl is still not provided — the directory collaborator is a required dependency.)

The builders are what keep run_oop_serving callable: it is pub and takes this type by value, so an out-of-crate caller — an integration test driving the real serve path, for instance — needs some way to build one.

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.

Implementations

impl OopServeOptions

pub fn new( gear_name: String, instance_id: String, advertise_uri: String, listen_addr: SocketAddr, directory: Arc<dyn DirectoryClient>, ) -> Self

Create OopServeOptions with the fields that have no meaningful default; every optional field defaults to the bootstrap config layer’s own default (drain_timeout 30s, heartbeat_interval 5s, healthcheck_timeout 500ms, no probe sidecar port, no authenticators, no labels). Layer the rest on with the with_* builders.

pub fn with_version(self, version: Option<String>) -> Self

Set the gear version (used for registration + OpenAPI version).

pub fn with_probe_bind_addr(self, addr: Option<SocketAddr>) -> Self

Serve probes on a separate sidecar port in addition to the main listener.

pub fn with_drain_timeout(self, timeout: Duration) -> Self

Override how long in-flight requests may drain on shutdown.

pub fn with_heartbeat_interval(self, interval: Duration) -> Self

Override the DirectoryService heartbeat interval.

pub fn with_healthcheck_timeout(self, timeout: Duration) -> Self

Override the per-check readiness healthcheck timeout.

pub fn with_bearer_authenticator( self, auth: Option<DynBearerAuthenticator>, ) -> Self

Install the tenant-plane authenticator (security_context_middleware).

pub fn with_internal_authenticator( self, auth: Option<DynInternalAuthenticator>, ) -> Self

Install the platform-plane authenticator (internal_auth_middleware).

pub fn with_labels(self, labels: BTreeMap<String, String>) -> Self

Advertise stable addressing labels for label-based selection.

Trait Implementations

impl Debug for OopServeOptions

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

Formats the value using the given formatter.