dspy_rs::trace

Generated from rustdoc JSON at dspy-rs v0.7.3 (commit b5da857). Do not edit by hand; regenerate with python3 docs/scripts/gen_api.py (see the script header for the rustdoc commands). Item links lead to full signatures and method docs on docs.rs.

Execution trace capture (RFC 0001).

Re-exports

Item	Description
`capture::*`	Glob re-export.
`export::*`	Glob re-export.
`is_replaying`	Re-export of `replay::is_replaying`.
`replay`	Re-export of `replay::replay`.
`ReplayError`	Re-export of `replay::ReplayError`.
`ReplayMode`	Re-export of `replay::ReplayMode`.
`ReplayReport`	Re-export of `replay::ReplayReport`.
`span::*`	Glob re-export.
`TRACE_FORMAT_VERSION`	Re-export of `serialize::TRACE_FORMAT_VERSION`.

Modules

Item	Description
`capture`	Task-local capture scope for the unified trace format.
`export`	Exports: projections of the trace format onto external training and observability conventions (RFC 0001 §4f/§4g).
`replay`	Replay scope: serve `Predict` calls from a recorded `Trace` (RFC 0001 §4d/§4e).
`serialize`	JSONL wire format for `Trace`: header line, span lines, optional footer.
`span`	The unified trace format (RFC 0001): one `Span` per `Predict` invocation, one `Trace` per rollout.

`trace::capture`

Task-local capture scope for the unified trace format.

Structs

Item	Description
`SpanGuard`	Owns a `SpanId` — event/close attribution travels with the guard, never through “innermost open span” lookups, so interleaved `Predict`s on one task (`futures::join!`) cannot cross…
`SpanOutcome`	Everything recorded lazily at span close.
`SpanRequest`	Everything recorded eagerly at span open.
`TraceSink`	Shared handle to an in-progress trace.

Functions

Item	Description
`begin_span`	Opens a span in the active capture scope. Returns `None` when no scope is active — the caller does nothing else in that case (zero-overhead path).
`capture_with_meta`	`capture` with caller-provided rollout metadata (input, candidate hash, tags). Missing `trace_id`/`started_at_us` are minted at scope start.
`capture`	Runs `f` while recording every `Predict` call on this task into a `Trace`.
`is_capturing`	Returns `true` if the current task is inside a `capture` scope.

`trace::export`

Exports: projections of the trace format onto external training and observability conventions (RFC 0001 §4f/§4g).

Re-exports

Item	Description
`OtelEvent`	Re-export of `otel::OtelEvent`.
`OtelKeyValue`	Re-export of `otel::OtelKeyValue`.
`OtelSpan`	Re-export of `otel::OtelSpan`.
`OtelStatus`	Re-export of `otel::OtelStatus`.
`OtelValue`	Re-export of `otel::OtelValue`.
`RlRollout`	Re-export of `rl::RlRollout`.
`RlTransition`	Re-export of `rl::RlTransition`.

`trace::export::otel`

OTel export (RFC 0001 §4g): one-way batch mapping of a finished Trace onto OpenTelemetry GenAI semantic conventions — as plain serializable structs in the OTLP/JSON wire shape, w…

Structs

Item	Description
`OtelEvent`	OTLP span `Event`.
`OtelKeyValue`	OTLP `KeyValue`.
`OtelSpan`	One span in the OTLP/JSON wire shape (proto3 JSON mapping: camelCase keys, 64-bit integers as decimal strings, ids as lowercase hex).
`OtelStatus`	OTLP span `Status`.

Enums

Item	Description
`OtelValue`	OTLP `AnyValue` (the oneof arms this export emits).

Constants

Item	Description
`SPAN_KIND_CLIENT`	OTLP `SPAN_KIND_CLIENT`.
`SPAN_KIND_INTERNAL`	OTLP `SPAN_KIND_INTERNAL`.
`STATUS_CODE_ERROR`	OTLP `STATUS_CODE_ERROR`.

`trace::export::rl`

RL rollout export (RFC 0001 §4f): the Agent Lightning / verifiers span convention — one rollout as message lists + reward + per-subcall transitions.

Structs

Item	Description
`RlRollout`	One rollout: reward plus per-subcall transitions. Serializes to a single JSON object — the JSONL record RL trainers consume.
`RlTransition`	One policy subcall — a `Predict` invocation as (prompt messages, emitted completion) with its span metadata.

`trace::replay`

Replay scope: serve Predict calls from a recorded Trace (RFC 0001 §4d/§4e).

Structs

Item	Description
`ReplayReport`	What a replay scope did, returned by `replay` alongside the closure’s result.

Enums

Item	Description
`ReplayError`	Why a call could not be served from the recording.
`ReplayMode`	How a replay scope treats a call that does not match its recording.

Functions

Item	Description
`is_replaying`	Returns `true` if the current task is inside a `replay` scope.
`replay`	Runs `f` with `trace` as the canned-response source for every `Predict` call on this task. Returns the closure’s result and a `ReplayReport` of what was served versus live.

`trace::serialize`

JSONL wire format for Trace: header line, span lines, optional footer.

Constants

Item	Description
`TRACE_FORMAT_VERSION`	Highest format version this reader understands.

`trace::span`

The unified trace format (RFC 0001): one Span per Predict invocation, one Trace per rollout.

Structs

Item	Description
`CompId`	Per-trace interned component index. The component name is the same string the params system addresses: an fx slot name (`"drafter"`) or a facet dotted path (`"pipeline.rater"`).
`Eval`	The metric result type: one score, optional textual feedback.
`ModelEntry`	Interned model configuration: `LMConfig` minus live state, minus secrets.
`ModelId`	Per-trace interned model configuration.
`PrefixEntry`
`PrefixId`	Per-trace interned prompt prefix (system message + demo turns). One entry per distinct (component, candidate) configuration — demos serialize once per trace, not once per span.
`Span`	One `Predict` invocation: one rendered prompt in, one parsed output out, with the tool loop’s inner structure as ordered events.
`SpanError`
`SpanId`	Index of a span within its trace. Dense, assigned in insertion order.
`Trace`	One rollout: ordered spans plus per-trace intern tables.
`TraceMeta`
`TraceOutcome`

Enums

Item	Description
`SpanErrorKind`
`SpanEvent`	Ordered events inside a span. Tagged; readers skip unknown tags — this is the streaming seam (RFC 0001 §6).

Type aliases

Item	Description
`JsonMap`

Overview

dspy-rs

Companion crates

dspy_rs::trace

Re-exports

Modules

`trace::capture`

Structs

Functions

`trace::export`

Re-exports

`trace::export::otel`

Structs

Enums

Constants

`trace::export::rl`

Structs

`trace::replay`

Structs

Enums

Functions

`trace::serialize`

Constants

`trace::span`

Structs

Enums

Type aliases

​Re-exports

​Modules

​trace::capture

​Structs

​Functions

​trace::export

​Re-exports

​trace::export::otel

​Structs

​Enums

​Constants

​trace::export::rl

​Structs

​trace::replay

​Structs

​Enums

​Functions

​trace::serialize

​Constants

​trace::span

​Structs

​Enums

​Type aliases

Re-exports

Modules

`trace::capture`

Structs

Functions

`trace::export`

Re-exports

`trace::export::otel`

Structs

Enums

Constants

`trace::export::rl`

Structs

`trace::replay`

Structs

Enums

Functions

`trace::serialize`

Constants

`trace::span`

Structs

Enums

Type aliases