This reference describes unreleased code on main; no release documents it yet.

rlmesh::serve_options::ServeOptions

structPreviewuse rlmesh::serve_options::ServeOptions;[source]

Transport lifecycle policy for a server.

struct ServeOptions

Defaults: remote shutdown off, no idle shutdown, no drain or close bound (an env server caps each at 5 s), no declared edition, uncompressed responses. Options are plain data: the server that consumes them validates them (a timeout must be positive) and resolves the edition.

Build one with ..Default::default(); appending a field is a minor change by project policy, so a full struct literal is unsupported.

Also available as rlmesh::ServeOptions.

allow_remote_shutdown

field[source]
allow_remote_shutdown: bool

Honor a client shutdown RPC. When false, remote shutdown requests are rejected.

idle_timeout

field[source]
idle_timeout: Option<std::time::Duration>

Shut the server down after this much inactivity. None never times out.

drain_timeout

field[source]
drain_timeout: Option<std::time::Duration>

Maximum time to drain in-flight requests during shutdown. None is the server’s default (5 s for an env server).

close_timeout

field[source]
close_timeout: Option<std::time::Duration>

Maximum time the env’s (or model’s) close may take on shutdown. None is the server’s default (5 s for an env server).

workflow_edition

field[source]
workflow_edition: Option<String>

The workflow edition this server declares: the serve call’s own value, adopted ahead of RLMESH_WORKFLOW_EDITION. A blank value declares nothing.

compress_responses

field[source]
compress_responses: bool

Compress environment responses (zstd, else gzip) for a client that accepts them. Has no effect on the model server.

Trait implementations

  • impl Debug for ServeOptions
  • impl Clone for ServeOptions
  • impl Default for ServeOptions