API reference

The generated API reference for FerroMatch is hosted in the canonical docs site. It covers the deterministic matching core, binary I/O primitives, memory-mapped journal, server runtime, and stress client.

API bundles

• ferromatch_core — order book, matching engine, commands, events, and domain types.
• ferromatch_io — binary codec and ring-buffer primitives.
• ferromatch_journal — append-only event journal and replayable persistence contracts.
• ferromatch_server — server runtime, publisher, recovery, and engine-thread orchestration.
• stress — load-test client entry points for operational validation.

Start here

• Getting started walks through a deterministic match cycle.
• Matching cycle example shows the command/event boundary used by replay and journaling.