smol/README.md

35 lines
1.2 KiB
Markdown
Raw Normal View History

2020-02-06 14:09:00 +00:00
## Goals
2020-02-04 14:08:34 +00:00
2020-02-06 11:18:50 +00:00
* Small - Fits into a single source file.
2020-02-05 18:54:55 +00:00
* Fast - On par with async-std and Tokio.
2020-02-06 19:56:20 +00:00
* Safe - Written in 100% safe Rust.
* Complete - Fully featured and ready for production.
2020-02-07 10:54:50 +00:00
* Documented - Simple code, easy to understand and modify.
2020-02-04 13:11:12 +00:00
* Portable - Works on Linux, Android, macOS, iOS, and Windows.
2020-02-07 10:54:50 +00:00
* Lightweight - Small dependencies, relies on epoll/kqueue/WSApoll.
2020-02-06 14:09:00 +00:00
## Features
2020-02-06 11:18:50 +00:00
* Executor - Configurable threads, work stealing, supports non-send futures.
2020-02-04 13:11:12 +00:00
* Blocking - Thread pool for isolating blocking code.
2020-02-06 14:09:00 +00:00
* Networking - TCP, UDP, Unix domain sockets, and custom files/sockets.
2020-02-06 19:56:20 +00:00
* Process - Spawns child processes and interacts with their I/O.
* Files - Filesystem manipulation operations.
2020-02-06 14:09:00 +00:00
* Stdio - Asynchronous stdin, stdout, and stderr.
2020-02-04 13:11:12 +00:00
* Timer - Efficient userspace timers.
2020-02-04 10:27:09 +00:00
## License
<sup>
Licensed under either of <a href="LICENSE-APACHE">Apache License, Version
2.0</a> or <a href="LICENSE-MIT">MIT license</a> at your option.
</sup>
<br/>
<sub>
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.
</sub>