{"id":13415627,"url":"https://github.com/vertexclique/nuclei","last_synced_at":"2025-04-12T21:33:55.787Z","repository":{"id":40583510,"uuid":"277511765","full_name":"vertexclique/nuclei","owner":"vertexclique","description":"Proactive IO \u0026 Runtime system","archived":false,"fork":false,"pushed_at":"2024-04-15T08:16:12.000Z","size":38328,"stargazers_count":240,"open_issues_count":4,"forks_count":18,"subscribers_count":7,"default_branch":"master","last_synced_at":"2024-05-22T14:33:37.283Z","etag":null,"topics":["async","epoll","io","iocp","iouring","kqueue","lock-free","proactor","runtime","rust-lang","zero-cost-abstraction"],"latest_commit_sha":null,"homepage":"https://vertexclique.github.io/nuclei/","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vertexclique.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"vertexclique"}},"created_at":"2020-07-06T10:28:50.000Z","updated_at":"2024-07-30T23:48:24.959Z","dependencies_parsed_at":"2024-07-30T23:58:23.110Z","dependency_job_id":null,"html_url":"https://github.com/vertexclique/nuclei","commit_stats":{"total_commits":77,"total_committers":4,"mean_commits":19.25,"dds":"0.038961038961038974","last_synced_commit":"77780b9434e2ca2305a2e5111e1133b4b6247c3c"},"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vertexclique%2Fnuclei","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vertexclique%2Fnuclei/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vertexclique%2Fnuclei/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vertexclique%2Fnuclei/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vertexclique","download_url":"https://codeload.github.com/vertexclique/nuclei/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248636804,"owners_count":21137527,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["async","epoll","io","iocp","iouring","kqueue","lock-free","proactor","runtime","rust-lang","zero-cost-abstraction"],"created_at":"2024-07-30T21:00:50.880Z","updated_at":"2025-04-12T21:33:55.765Z","avatar_url":"https://github.com/vertexclique.png","language":"Rust","funding_links":["https://github.com/sponsors/vertexclique"],"categories":["Rust","Libraries","others"],"sub_categories":["Rust"],"readme":"\u003ch1 align=\"center\"\u003e\n    \u003cimg src=\"https://github.com/vertexclique/nuclei/raw/master/img/nuclei.gif\"/\u003e\n\u003c/h1\u003e\n\u003cdiv align=\"center\"\u003e\n \u003cstrong\u003e\n   Nuclei: Proactive IO \u0026 Runtime system\n \u003c/strong\u003e\n\u003chr\u003e\n\u003c/div\u003e\n\n\u003cdiv align=\"center\"\u003e\n    \u003c!-- CI builds --\u003e\n    \u003ca href=\"https://github.com/vertexclique/nuclei/actions\"\u003e\n    \u003cimg alt=\"Build Status\" src=\"https://github.com/vertexclique/nuclei/workflows/CI/badge.svg\" /\u003e\n    \u003c/a\u003e\n    \u003c!-- Crates version --\u003e\n    \u003ca href=\"https://crates.io/crates/nuclei\"\u003e\n    \u003cimg alt=\"Crates.io\" src=\"https://img.shields.io/crates/v/nuclei.svg?style=popout-square\"\u003e\n    \u003c/a\u003e\n    \u003c!-- License --\u003e\n    \u003ca href=\"https://github.com/vertexclique/nuclei/blob/master/LICENSE\"\u003e\n    \u003cimg alt=\"Crates.io\" src=\"https://img.shields.io/crates/l/nuclei.svg?style=popout-square\"\u003e\n    \u003c/a\u003e\n    \u003c!-- Downloads --\u003e\n    \u003ca href=\"https://crates.io/crates/nuclei\"\u003e\n    \u003cimg src=\"https://img.shields.io/crates/d/nuclei.svg?style=flat-square\"\n      alt=\"Download\" /\u003e\n    \u003c/a\u003e\n    \u003c!-- docs.rs docs --\u003e\n    \u003ca href=\"https://docs.rs/nuclei\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/docs-latest-blue.svg?style=flat-square\"\n      alt=\"docs.rs docs\" /\u003e\n    \u003c/a\u003e\n    \u003c!-- Discord --\u003e\n    \u003ca href=\"https://discord.gg/DqRqtRT\"\u003e\n    \u003cimg src=\"https://img.shields.io/discord/628383521450360842.svg?logo=discord\" /\u003e\n    \u003c/a\u003e\n\u003c/div\u003e\n\nNuclei is a [proactor-based](http://citeseerx.ist.psu.edu/viewdoc/summary?doi=10.1.1.49.9183) IO system which is runtime agnostic and can work with any runtime.\nThe proactor system's design principles are matching [Boost Asio](https://www.boost.org/doc/libs/1_47_0/doc/html/boost_asio/overview/core/async.html).\nNuclei is not using a conventional reactor approach. It is completely asynchronous, and it's wrapping poll based IO in a proactive fashion.\n\nNuclei uses [io_uring](https://kernel.dk/io_uring.pdf) on Linux as the primary IO backend, secondarily you can use [epoll](https://en.wikipedia.org/wiki/Epoll). On MacOS, Nuclei is using [kqueue](https://en.wikipedia.org/wiki/Kqueue).\nOn Windows, the [IOCP](https://en.wikipedia.org/wiki/Input/output_completion_port) backend [will be used](https://github.com/vertexclique/nuclei/pull/3).\n\nThe current io_uring implementation needs a modern Linux kernel (5.19+).\n\n## Features\n\n* Most of the recent IO_URING features are available, ZC and other 6.1+ features are in TODO.\n* Async TCP, UDP, Unix domain sockets and files...\n* The proactor system doesn't block\n* Scatter/Gather operations\n* Minimal allocation\n* More expressive than any other runtime\n* Completely asynchronous I/O system with lock free programming\n\n## Examples\nPlease head to `examples` directory to run the examples:\n```shell script\n$ cd examples\n$ cargo run --example fread-vect\n```\n\n## Tests\n\n```shell script\n$ cargo test --no-default-features --features=iouring # For iouring\n$ cargo test # For others\n```\n\n## Configurations\n\n### Evented IO backend\n\nWhen the `iouring` feature gate is not enabled, the platforms evented backend is used. For example, on Linux, `epoll` would be used.\n\n### Executor\n\nExecutor is using `async-global-executor`. Available features are:\n* `async-exec`: Uses `async-io` feature of `async-global-executor`.\n* `tokio`\n\n#### License\n\n\u003csup\u003e\nLicensed under either of \u003ca href=\"LICENSE-APACHE\"\u003eApache License, Version\n2.0\u003c/a\u003e or \u003ca href=\"LICENSE-MIT\"\u003eMIT license\u003c/a\u003e at your option.\n\u003c/sup\u003e\n\n\u003cbr\u003e\n\n\u003csub\u003e\nUnless you explicitly state otherwise, any contribution intentionally submitted\nfor inclusion in this crate by you, as defined in the Apache-2.0 license, shall\nbe dual licensed as above, without any additional terms or conditions.\n\u003c/sub\u003e\n\n##### Credits\n\n\u003csub\u003e\u003csup\u003eGif is from the documentary called \"Particle Fever\".\u003csup\u003e\u003csub\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvertexclique%2Fnuclei","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvertexclique%2Fnuclei","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvertexclique%2Fnuclei/lists"}