Documentation

Clamp documentation

Clamp brings independent Rust components together into coherent applications. These pages explain the model, show the runnable examples, and say plainly which parts exist today.

Status. Clamp is an early prototype. The facade works end to end; Core and Kernel are prototypes with tests and measurements; Runtime has no public contracts yet. Nothing is on crates.io. Each page tags its concepts Works Prototype In progress or Planned.

Start here

  • Getting started — clone the repositories and run Hello Clamp in under a minute.
  • Examples — the six runnable steps from Pico to a multi-process blueprint.
  • Concepts — the vocabulary in one page.

The model in one picture

Your code  +  Rust crates  +  Clamp modules
                   │
                   ▼
    Requirements · Capabilities · Contributions
                   │
                   ▼
   Process projection  →  Freeze  →  Run

A module declares what it requires and what it provides. Kernel resolves those capabilities by type, assembles contributions into their targets, keeps only what a process can reach, and freezes the result before any work runs.

Read by topic

PageWhat it coversStatus
ModulesIdentity, Requires, Provides; additive declarationsPrototype
CapabilitiesTyped ability contracts and how they resolvePrototype
ContributionsAssembling a subsystem from many modulesPrototype
ProcessesProjection, reachability, freeze, inspectionPrototype
LifecycleInitialize, start, ready, drain, stopIn progress
ArchitectureLayers, crates and the rules between them—
KernelWhat coordination Kernel does and does not doPrototype
RuntimeThe execution-environment boundaryPlanned
Progressive controlUse, configure, extend, replace, ownPlanned

Source

The framework lives in four public repositories under github.com/rustclamp: rustclamp (facade, examples, ADRs, evidence), core, kernel and runtime. Design decisions are recorded as ADRs in rustclamp/docs/adr; measurements in rustclamp/docs/evidence.