Nuclei is a proactive async runtime for Rust. A task hands its IO to the driver of its core and gets the result back completed; every core runs a shard of its own, with its tasks, timers, buffers and driver. The chapters follow the path below: start, the core ideas, then each area of the crate.
Every example runs
Each program on these pages is a file the site's build compiles, lints and runs on Linux, on io_uring and on epoll, before every deploy. The ones that need Unix (Unix sockets, signals, programs such as sort) say so.
Where to start
- New to async Rust: read in order. Setup, How it works, Runtime and Tasks are the core.
- Coming from a readiness-based runtime: start with Migrate. Most names carry over; dropping a task handle and a write's completion behave differently.
- Looking for one item: press Ctrl K (⌘ K on a Mac) to search these pages and the API reference.