C API
Generated from crates/niso-capi/build.rs when the site was built at 7aa23e2.
Every language reaches niso through one API over node ids. Its C form is two headers, which crates/niso-capi’s build script writes and this reference is generated from on every build of the site:
niso.h, generated fromidl/*.webidlbyniso-idl: 1627 functions, one per attribute getter and setter, operation and constructor. They are listed under each interface in the Web API reference, with their C prototypes.niso_runtime.h, written by hand in sections that each belong to one crate and composed byniso-compose(crates/niso-compose/sections.txt): what the IDL can’t say, 183 functions in all with the headers below.niso.hincludes it.
Start with Conventions: the rules every caller follows. Both composed headers are also served whole: niso.h and niso_runtime.h. To get them in a checkout, run cargo xtask docs, which writes them to target/docs/.
niso_runtime.h, by section
Section titled “niso_runtime.h, by section”| Section | Owner | Functions |
|---|---|---|
| Conventions | niso-compose |
0 |
| types | niso-base |
0 |
| status | niso-base |
0 |
| event-loop | niso-sched |
4 |
| storage-driver | niso-storage |
0 |
| storage-config | niso-storage |
3 |
| structured-clone | niso-structured-clone |
4 |
| hooks | niso-core |
0 |
| document | niso-core |
22 |
| loading | niso-core |
6 |
| rendering | niso-core |
25 |
| handles | niso-core |
4 |
| worker-hooks | niso-messaging |
0 |
| workers | niso-messaging |
12 |
| network | niso-fetch |
7 |
| media | niso-media |
6 |
| modules | niso-modules |
7 |
| wasm | niso-wasm |
27 |
Other headers
Section titled “Other headers”- niso_app.h: apps in any language
- niso_engine.h: the engine interface
- niso_js.h: the JS binding
- niso_intl.h: Intl for engines without it