Navigation

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

rlmesh::env::RemoteEnvOptions

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

Options for connecting to a single or vector environment.

struct RemoteEnvOptions

address excludes the helpers (host, port, path, transport); without either the constructor fails with the ValueError class. A zero timeout means no timeout, as None does.

Also available as rlmesh::RemoteEnvOptions.

Fields

Methods

address

field[source]
address: Option<String>

The endpoint (tcp://host:port, host:port or unix:///path).

host

field[source]
host: Option<String>

TCP host helper (default 127.0.0.1); needs port.

port

field[source]
port: Option<u16>

TCP port helper.

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, Tcp refuses it.

connect_timeout

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

Bound on the dial and handshake.

request_timeout

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

Bound on each reset, step, render and shutdown, also sent to the server as the request deadline; close uses it too.

workflow_edition

field[source]
workflow_edition: Option<String>

The workflow edition this client declares on the handshake; empty or whitespace declares nothing and resolution continues.

address

method[source]
fn address(self, address: impl Into<String>) -> Self

Set address.

host

method[source]
fn host(self, host: impl Into<String>) -> Self

Set host.

port

method[source]
fn port(self, port: u16) -> Self

Set port.

path

method[source]
fn path(self, path: impl Into<String>) -> Self

Set path.

transport

method[source]
fn transport(self, transport: Transport) -> Self

Set transport.

connect_timeout

method[source]
fn connect_timeout(self, timeout: impl Into<Duration>) -> Self

Set connect_timeout.

request_timeout

method[source]
fn request_timeout(self, timeout: impl Into<Duration>) -> Self

Set request_timeout.

workflow_edition

method[source]
fn workflow_edition(self, edition: impl Into<String>) -> Self

Set workflow_edition.

Trait implementations

  • impl Clone for RemoteEnvOptions
  • impl Debug for RemoteEnvOptions
  • impl Default for RemoteEnvOptions