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

rlmesh::specs::EnvContract

structPreviewuse rlmesh::specs::EnvContract;[source]

The contract an env endpoint serves.

struct EnvContract

Only the library builds one (an EnvServer derives it from the env; a remote client reads it from the handshake). Clones are independent values.

Also available as rlmesh::EnvContract.

Methods

fn id(&self) -> &str

The env id ("UnknownEnv-v1" when the env sets none).

fn observation_space(&self) -> &SpaceSpec

The space one observation belongs to.

fn action_space(&self) -> &SpaceSpec

The space one action belongs to.

fn render_mode(&self) -> Option<&str>

The env’s render mode, if any.

fn num_envs(&self) -> u64

The number of lanes the endpoint serves.

fn metadata(&self) -> Option<&Metadata>

The env’s metadata, tags included, if any.

fn env(&self) -> EnvContract

The env alias: a copy of this contract.

fn spec(&self) -> EnvContract

The spec alias: a copy of this contract.

fn to_dict(&self) -> Metadata

A dictionary containing id, render_mode, num_envs, metadata, and each space as {kind, shape, dtype, details}.