Skip to main content

Crate rlmesh_proto

Crate rlmesh_proto 

Source
Expand description

Generated RLMesh protobuf bindings and protocol-level constants.

Modules§

capabilities
Stable capability names exchanged during handshake.
core
env
model
spaces

Structs§

EditionDefaults
The edition-governed defaults one Edition promises: the values a participant would otherwise hardcode, lifted here so a future default change is a new row rather than an edit to a code path a sealed edition already depends on. One row per arm, returned by defaults; a sealed row is never edited.
EditionRefusal
No edition satisfies every participant — the negotiation’s clean refusal.
EndpointPhases
The endpoint-local split of JoinResponse.endpoint_total_ns (ns), plus the pre-handler wait and slot depth a pipelining model endpoint reports.
PeerInfoOverride
Advisory runtime identity supplied by a non-Rust host (e.g. the Python SDK) to enrich the handshake PeerInfo.
SessionFloor
The reconciled workflow edition produced by negotiate_session_floor.
SessionOffer
One participant’s bind-time offer: the two sets it brings to negotiation.
TierOffer
One tier’s position in a refused negotiation, for the diagnostic.
UnknownEdition
A wire edition name no Edition arm implements.

Enums§

Edition
A workflow semantics edition this build implements.
RuntimeCap
Why the runtime capped a session below what its peers would have run at.

Constants§

BUILD_COHORT
Build cohort used to spell CURRENT_WORKFLOW_EDITION.
BUILD_SOURCE
Source of the build cohort: release, package, or git.
CURRENT_WORKFLOW_EDITION
Current workflow semantics edition.
PROTOCOL_GENERATION
Identity of the frozen wire substrate: the core handshake plus the spaces value transport the runtime relays between env and model. NOT the package version, NOT the product semver, and NOT a per-service version — it names the one shared byte contract every component is built against, decoupled from all of them.
SUPPORTED_WORKFLOW_EDITIONS
Workflow editions this crate can operate under, generated by build.rs from rlmesh.toml’s [workflow] supported_editions with CURRENT_WORKFLOW_EDITION first. Each edition names an immutable behavioral contract documented in docs/editions/<base>.md (the spec file is keyed by the bare YYYY.MM base, never the suffixed cohort), so a sealed edition is retained here under its bare name for as long as the crate can still drive it. A published crate ships no rlmesh.toml; it reads the same list from its shipped supported_editions.txt.
WORKFLOW_EDITION_BASE
Bare YYYY.MM workflow edition base for this build.

Functions§

capability_map
Return a handshake capability map for the given capability names.
core_handshake_request
The core handshake request this build sends as a gRPC client: its protocol generation, the editions it CAN drive, the edition it declares (WANT), its advertised capabilities, and PeerInfo. Shared by the env and model clients (each wraps it in its service-specific request) so the request shape cannot drift between services.
declared_workflow_edition
The edition a participant declares (its WANT): the explicit declaration, or CURRENT_WORKFLOW_EDITION when it declares none. Whitespace is trimmed and an empty declaration reads as absent.
defaults
The defaults row governing a session running at edition.
edition_sort_key
Ordering key for a workflow edition name: (base, cohort?, suffix).
elapsed_ns
Nanoseconds elapsed since started_at, saturating instead of wrapping.
evaluate_handshake
Whether a client’s handshake offer is compatible with this server: the only handshake-level decision is protocol generation (a hard, full-restart break).
generation_mismatch_message
The human-facing rejection message when a client’s protocol generation does not match this server. Generation is the ONLY handshake-level rejection; an edition mismatch is decided — and diagnosed — by the runtime’s floor, not here. Shared by the env and model servers so the rejection prose cannot drift.
has_capability
Whether a peer’s handshake capability map advertises the named capability.
is_protocol_generation_supported
Whether the given protocol generation is the one this build speaks. Plain equality — there is no support window. Whitespace is trimmed so a padded wire value still matches.
is_retained_edition
Whether this build retains edition: it has an arm for it AND SUPPORTED_WORKFLOW_EDITIONS (generated from rlmesh.toml) still names a spelling of it.
lane_final_info
A completing lane’s final info from a step’s infos, lane being its position among the width lanes the step covered. An explicit final_info entry wins (masked by _final_info). Otherwise a single-lane step’s info IS the final info, and a vector step’s lane is sliced out of the Gymnasium vector-info layout. None when the lane has nothing.
lane_skew_ns
Straggler skew across a vector env’s lanes for one op: how much longer the slowest lane took than the median lane, in nanoseconds.
negotiate_session_floor
Reconcile the route’s workflow edition across env, model, and this runtime.
negotiate_workflow_edition
Select the workflow edition governing a session between this runtime and one peer — the co-located floor (env ∩ self) the in-process / run_local path runs at, with the model and runtime being the same build.
parse_declared_edition
Resolve a declared edition — a participant’s WANT — to the arm it names, or say why this build cannot declare it.
parse_retained_edition
Resolve a wire edition name to the arm this build both implements AND retains, or say why it cannot.
peer_info
Build advisory PeerInfo diagnostics for a handshake.
set_peer_info_override
Install (or replace) the process-wide PeerInfoOverride consulted by peer_info. Intended for non-Rust hosts (the Python SDK) to report their real runtime. Idempotent and thread-safe; passing the value again overwrites.
supported_workflow_editions
Return supported workflow editions as owned strings for protobuf messages.
want_admits
Whether a declared WANT admits edition as the session’s edition.