Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Crate index

Reference · generated · every workspace crate by tier, with the description its manifest carries

A tier depends only on the tiers below it; the peripheral surface depends on all of them and is depended on by none. The description column is each crate’s Cargo.toml description, so this table is exactly what cargo metadata reports. The status column is the crate’s package.metadata.pulse-mesh.status: pre-integration for a crate the tree ships but does not use yet (ADR-0014), partial for one in use some of whose public entry points return a deferred error (ADR-0017), blank for one that is finished and wired in.

The canonical primitive (tier 0, pulse/)

CratePathStatusDescription
gen-test-vectorspulse/pulse-spec/tools/gen-test-vectorsRegenerate the language-neutral conformance fixtures under test-vectors/.
mesh-capabilitypulse/mesh-capabilityPulse Mesh capability negotiation: per-node feature flags + version negotiation handshake.
mesh-contextpulse/mesh-contextpre-integrationPulse Mesh Context Registry / Book of Standards: 16-bit context_id + 16-bit subscope namespace partitioning of the Pulse scope field.
mesh-lexpulse/mesh-lexPulse Mesh public conformance substrate — minimum-viable lex registry + Merkle root over the registered catalog.
pulse-canonpulse/pulse-canonPulse Mesh canonical primitive: the 128-byte Pulse + PulseEnvelope codec + NodeId. Tier 0 (the shape).

The engine (tier 1, core/)

CratePathStatusDescription
core-backoffcore/core-backoffPulse Mesh backoff for OS-visible stalls: spin, then yield, then sleep in fixed steps. Tier 1 (the engine).
core-regioncore/core-regionPulse Mesh shared-memory mechanism (shm_open, size and reserve, mmap, unlink), NUMA placement (hugepage backings, mbind, thread pinning) and PulseRegion, the single-slot region. Tier 1 (the engine).
core-ringcore/core-ringPulse Mesh SHM-backed SeqLock ring buffer (single-writer, N-reader). Tier 1 (the engine).
core-storecore/core-storePulse Mesh EnvelopeStore: SHM circular buffer for variable-size envelopes with content-addressed lookup. Tier 1 (the engine).
core-transportcore/core-transportPulse Mesh PulseSender / PulseReceiver trait family. Substrate-agnostic transport contract. Tier 1 (the engine).
mesh-stage-registrycore/mesh-stage-registryCompile-time stage / function registry macro for ring hubs. The register_stages! macro enumerates a hub’s functions and stages and emits RING_MANIFEST, so the inner-ring four-crate composition is asserted in source and testable.
pms-crc32ccore/pms-crc32cPulse Mesh CRC32C trailer: compute and verify the checksum a Pulse carries in its last four bytes. Module M10. Tier 1 (the engine).
pulse-wire-udpcore/pulse-wire-udpUDP framing for the Pulse Mesh Standard wire transport: one Pulse + variable-size envelope per datagram, MTU-aware, CRC32C-protected, with optional backpressure, NACK retransmission and FEC.

The peripheral surface (tier peripheral, tools/, examples/)

CratePathStatusDescription
example-01-hello-pulse-rustexamples/01-hello-pulse-rustExample 01 — encode + decode a PulseEnvelope, print its BLAKE3 content hash.
example-02-loopback-udp-rustexamples/02-loopback-udp-rustExample 02 — a sender and a receiver thread exchanging Pulses over UDP loopback in one process.
example-03-embed-ring-rustexamples/03-embed-ring-rustExample 03 — the shared-memory ring and the envelope store used directly, without the daemon.
gen-lex-roottools/gen-lex-rootRegenerate the published lex_root (pulse/pulse-spec/lex-root.txt) for the current public mesh-lex registry state, into the path given.
pulse-clitools/pulse-cliThe standard’s own command line, pulse: encode, decode and verify envelopes, send and receive Pulses over UDP, and the loopback smoke bench, over pulse-canon and pulse-wire-udp alone. Peripheral.