v0.1
GitHub
On this page
  1. On docs.rs
  2. Built locally
  3. Where to start reading

Docs Reference

API reference

The API reference is generated by rustdoc from the crates themselves, so every type, trait and function is documented where it is defined, and every example in it is compiled and run as a test.

On docs.rs #

The reference for the facade and every crate of the family is on docs.rs, built with all features:

Built locally #

For a commit that is not released, build it from a checkout:

shell
git clone https://github.com/turnframe-rs/turnframecd turnframecargo doc -p turnframe --all-features --no-deps --open

--no-deps keeps the output to the family itself. Drop it to include the documentation of every dependency.

Where to start reading #

The facade's front page lists its modules by what belongs in each: flow for workflow definitions and the projector, turn for one user turn, interaction for durable cards, command for typed commands and policy, event for the claim ledger, response for the ordered blocks a turn returns, provider and store for the two things you plug in, and runtime for the pipeline itself. The working vocabulary is also re-exported at the crate root.

Type What it is
WorkflowDefinition the pure projector a domain implements: state in, WorkflowView out
WorkflowView one lifecycle phase, open obligations, at most one blocking card, an optional outcome
OperationSpec one operation as a turn offers it: arguments, targets, whether a model may propose it
Understanding what the tasks made of a message: units, acts, questions, constraints
Interaction a persistent, server-owned card the user answers
CommandEnvelope a typed command with its case, expected revision, idempotency key and origin
CommittedEvent an event in the ledger, the only thing a receipt may cite
Orchestrator runs one TurnInput through the whole pipeline

    Type to search the guides, the decision records and the changelog.