Nuclei is a proactor-based IO system which is runtime agnostic and can work with any runtime. The proactor system's design principles are matching Boost Asio. Nuclei is not using a conventional reactor approach. It is completely asynchronous, and it's wrapping poll based IO in a proactive fashion.

Nuclei uses epoll on Linux as the primary evented IO backend, secondarily (given system support) you can use io_uring. On MacOS, Nuclei is using kqueue. On Windows, the IOCP backend will be used.

The current io_uring implementation needs a modern Linux kernel (5.6+).

Features

• Async TCP, UDP, Unix domain sockets and files...
• The proactor system doesn't block
• Scatter/Gather operations
• Minimal allocation
• More expressive than any other runtime
• Completely asynchronous I/O system with lock free programming

Examples

Please head to examples directory to run the examples: shell script $ cd examples $ cargo run --example fread-vect

Tests

shell script $ cargo test --no-default-features --features=iouring # For iouring $ cargo test # For others

Configurations

Evented IO backend

When the iouring feature gate is not enabled, the platforms evented backend is used. For example, on Linux, epoll would be used.

Executor

Executor is using async-global-executor. Available features are: * async-exec: Uses async-io feature of async-global-executor. * tokio * tokio02 * tokio03

License

^{Licensed under either of Apache License, Version 2.0 or MIT license at your option.}

_{Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this crate by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.}

Credits

_{^{Gif is from the documentary called "Particle Fever".}}