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

rlmesh::recorder::Recorder

structPreviewuse rlmesh::recorder::Recorder;[source]

Accumulate workloads and export a portable result bundle.

struct Recorder

Capture hooks retain shared state independently of this handle. Returned workload values are snapshots; a hook can accumulate several runs. Explicit close removes staged assets; dropping a handle leaves live capture hooks valid and the last owner removes staging.

Also available as rlmesh::Recorder.

new

associated function[source]
fn new(options: RecorderOptions) -> Result<Self>

Construct a recorder, validating its capture and export options.

result_set_id

method[source]
fn result_set_id(&self) -> &str

Bundle identity (re-upload deduplication key).

workloads

method[source]
fn workloads(&self) -> Vec<WorkloadRecord>

Snapshot every workload in insertion order.

add

method[source]
fn add(
    &mut self,
    result: &RunResult,
    model: &str,
    env: &str,
    options: RecorderAddOptions,
) -> Result<WorkloadRecord>

Record a completed run, without media.

capture

method[source]
fn capture(
    &mut self,
    model: &str,
    env: &str,
    options: RecorderCaptureOptions,
) -> Result<Box<dyn RunHooks>>

Start a workload and return independent, shareable-lifetime capture hooks.

to_dict

method[source]
fn to_dict(&self, options: RecorderToDictOptions) -> Metadata

Snapshot the rlmesh.result.v1 document.

export_

method[source]
fn export_(
    &self,
    path: impl AsRef<Path>,
    options: RecorderExportOptions,
) -> Result<PathBuf>

Write a folder or ZIP bundle. Filesystem failures have the OSError class.

export_async

method[source]
async fn export_async(
    &self,
    path: impl AsRef<Path>,
    options: RecorderExportOptions,
) -> Result<PathBuf>

The async twin of export_. Dropping it stops further file operations.

close

method[source]
fn close(&mut self) -> Result<()>

Remove staged media. Idempotent; metric-only exports still work afterwards.

close_async

method[source]
async fn close_async(&mut self) -> Result<()>

The async twin of close.

Trait implementations

  • impl Debug for Recorder