Skip to content

Reference

The API reference below is generated from the packages’ Go source documentation (godoc) at build time and is never committed, so it always matches the released source.

  • state — The Crucible state-machine kernel: forging, firing, serialization, and visualization.
  • state/analysis — Static model-checking over a machine’s serializable IR.
  • state/evolution — Schema-evolution checks between two versions of a machine definition.
  • state/conformance — Conformance assertions and round-trip oracles for machine behavior.
  • state/verify — Bounded model-checking: reachability, invariants, liveness, and test generation.
  • state/verify/symbolic — Symbolic execution support for the verify tier.
  • state/expr — The rich-expression tier: CEL-backed guards, assigns, and time predicates.
  • sink — The fire-and-forget fan-out emitter: a Manifold dispatches one payload to many Outlets.
  • sink/sinktest — Conformance harness that verifies any Outlet implementation against the contract.
  • sink/bridge — Optional state-to-sink bridge: fan every machine transition out through a Manifold.
  • sink/sql — A database/sql destination through a narrow Tx interface, with no driver dependency.
  • sink/dynamo — An Amazon DynamoDB destination covering the full item-write surface.
  • sink/statsd — A StatsD/DogStatsD destination with a stateful, interval-flushing aggregator.
  • source — The stream-consume engine: an Inlet yields messages, a Hopper runs the ordered-concurrency consume loop and ack model.
  • source/memsource — An in-memory deterministic Inlet plus a test harness for the consume loop.
  • source/kafka — A Kafka/RedPanda Inlet over franz-go: group consumer, cooperative rebalance, mark-commit-after-process.
  • source/jetstream — A NATS JetStream Inlet over nats.go: pull consumer, ack/nak/term/inProgress, MaxAckPending backpressure.
  • source/cloudevents — A CloudEvents codec with structured and binary content modes.
  • source/retry — Classification-aware retry middleware: backoff for Retryable, straight to DLQ for Poison and InvalidForState.
  • source/dlq — Layered dead-letter middleware whose parking topic is itself an Inlet, so draining it is first-class replay.
  • source/idempotency — A Deduper seam with a no-op default; for the state-machine binding, dedup is transition idempotency.
  • source/schema — An optional proto/Avro/JSON-Schema validator that runs before the handler, routing invalid payloads to the DLQ.
  • source/statemachine — The state-to-source bridge: an inbound message drives a transition and the ack is tied to the durable transition.