Struct TraceRecorder 

pub struct TraceRecorder { /* private fields */ }

A running trace; cheap to clone, and every clone is the same trace.

Implementations

impl TraceRecorder

pub fn path(&self) -> &Path

The bundle directory.

pub fn mode(&self) -> &str

The trace’s mode.

pub fn links(&self) -> Option<PathBuf>

The Links Notation export, when one is being written.

pub fn stopped(&self) -> bool

Whether TraceRecorder::stop has run.

pub fn checkpoints(&self) -> Vec<JsonObject>

The checkpoints taken so far.

pub async fn checkpoint( &self, name: &str, ) -> Result<JsonObject, TraceRecordError>

Capture a checkpoint taken by the automation.

Errors

Fails after TraceRecorder::stop, or when a strict trace drops something.

pub async fn checkpoint_with( &self, name: &str, options: TraceCheckpointOptions, ) -> Result<JsonObject, TraceRecordError>

Capture a checkpoint; {index, name, actor, reason, url, truncated, members}.

Errors

As TraceRecorder::checkpoint.

pub async fn event( &self, name: &str, data: JsonObject, ) -> Result<Option<JsonObject>, TraceRecordError>

Record something a caller cares about on the same timeline; the record written, or None once the trace has stopped.

Errors

Fails when a strict trace drops the record.

pub async fn traced<T, E, F>( &self, action: &str, target: Option<&str>, work: F, ) -> Result<T, E>

where E: Display, F: Future<Output = Result<T, E>>,

Run one interaction and record it, as a traced commander method is.

target is the selector or URL acted on; typed text never belongs there. The interaction is recorded only when the trace records the interaction source, and the work’s own outcome is returned unchanged.

pub async fn stop(&self) -> Result<TraceResult, TraceRecordError>

Stop recording and write the manifest; calling it again returns the first result.

Errors

Fails when the manifest cannot be written or a strict trace drops something.

pub async fn stop_with( &self, options: TraceStopOptions, ) -> Result<TraceResult, TraceRecordError>

TraceRecorder::stop, discarding the bundle or recording the error the run ended with.

Errors

As TraceRecorder::stop.

Trait Implementations

impl Clone for TraceRecorder

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TraceRecorder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.