API reference
This reference is generated directly from the source of every published DotBoxD package, so it always
matches the code on main. Pick a namespace from the sidebar, or start with the entry points below.
Where to start
| You want to… | Reach for |
|---|---|
| Define and host an RPC contract | DotBoxD.Services ([DotBoxDService], RpcPeer, RpcHost) |
| Import, validate, and run a kernel under policy | DotBoxD.Hosting (SandboxHost, SandboxPolicyBuilder) |
| Work with the IR model, values, and resource limits | DotBoxD.Kernels (SandboxValue, SandboxType, ResourceLimits) |
| Round-trip kernels as JSON IR | DotBoxD.Kernels.Serialization.Json (JsonImporter, JsonExporter) |
| Author plugins and server extensions | DotBoxD.Abstractions ([Plugin], [HostBinding], [ServerExtension], HookContext) |
| Compose kernels next to host services over IPC | DotBoxD.Pushdown.Services (RpcMessagePackIpc) |
Conventions
- Source-generator diagnostics are namespaced
DBXS###(Services) andDBXK###(Kernels / plugins). See Reference › Diagnostics. - Public abstractions and generators are opt-in sugar over public primitives — anything a generator emits, you can hand-write against the same public API.
New here? The Tutorials show these types working together end to end.