Skip to main content

Module transcript

Module transcript 

Source
Expand description

Persisted transcript schema.

These types are the durable audit surface: what gets written to transcript.jsonl, what rite verify reads back, what report and audit tooling consume. They are deliberately kept independent of the executor and the channel plumbing, a third-party verifier can parse a transcript with only rite-model on its dependency list.

The live runtime↔frontend channel protocol (ExecEvent, UiCommand, Response, Icon, …) lives in rite-runtime next to the executor that owns the channels. The boundary is persisted vs in-flight.

Structs§

ErrorRecord
Structured error record for transcript serialization.
Level
Confidentiality level of a transcript line: who may see the fact.
Shown
A value on screen for a person to write down, with the shape that lays it out. Wiped when dropped; printed as its size and format, never its characters.
TranscriptHeader
First line of every transcript: what the file is, read before any fact.

Enums§

ErrorClass
Audit classification of a bad outcome, recorded so an auditor can tell the nature of a failure apart without parsing the free-form message.
Format
What kind of value a person types.
Prompt
Request for user input, recorded into the transcript as part of StepFact::PromptAnswered.
ResponseRecord
Serializable, redacted form of a user response.
StepFact
Durable, transcript-worthy fact.
StepOutcome
Outcome of a single step, carried by StepFact::StepCompleted.
ValidatorSpec
Validator applied by the runtime to a typed response before it is accepted.

Constants§

FACT_TYPES
The type tag of every StepFact variant in this vocabulary.
FACT_VOCABULARY
Version of the StepFact vocabulary this crate writes and reads. 0 before 1.0, like TRANSCRIPT_FORMAT.
PLACEHOLDER_LIMIT
The longest stand-in a Format::placeholder builds, in the format’s units. Large enough for any value a person would type or paste, and the entry itself is not bounded by it.
TRANSCRIPT_FORMAT
Transcript format version this crate writes and reads: the line envelope and the chain rule.
TRANSCRIPT_SCHEMA
URL of the JSON Schema for the transcript lines this release writes, written on the header line for editors and other tools. A reader ignores it.

Functions§

compile_pattern
Compile a pattern so that it must match the whole value.