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

rlmesh::env::EnvServerOptions

structPreviewuse rlmesh::env::EnvServerOptions;[source]

Options for constructing an environment server.

struct EnvServerOptions

Defaults: the address tcp://127.0.0.1:0, no serve options or tags, and close_env_on_shutdown true. Build one with ..Default::default(); appending a field is a minor change by project policy.

Also available as rlmesh::EnvServerOptions.

address

field[source]
address: Option<String>

The bind address (tcp://host:port or unix:///path); None uses the helpers below, or tcp://127.0.0.1:0. Excludes the helpers.

host

field[source]
host: Option<String>

TCP host helper (default 127.0.0.1).

port

field[source]
port: Option<u16>

TCP port helper (default 0, an OS-assigned port).

path

field[source]
path: Option<String>

Unix socket path helper; excludes host and port.

transport

field[source]
transport: Option<Transport>

Explicit transport; Unix needs path.

options

field[source]
options: Option<ServeOptions>

Transport lifecycle policy.

tags

field[source]
tags: Option<EnvTags>

Tags to merge into each served env’s metadata, validated against a scalar env’s spaces.

close_env_on_shutdown

field[source]
close_env_on_shutdown: bool

Close the env when the server stops (default true); false for a server in front of an env its caller closes.

ext

field[source]
ext: Option<EnvServerOptions>

Rust-only fields.

Trait implementations

  • impl Clone for EnvServerOptions
  • impl Debug for EnvServerOptions
  • impl Default for EnvServerOptions