doc: add some doc

Author: George-Miao

Cargo.toml

@@ -17,6 +17,14 @@ targets = [
     "x86_64-pc-windows-msvc",
     "x86_64-unknown-linux-gnu",
     "x86_64-apple-darwin",
+    "aarch64-apple-ios",
+    "aarch64-linux-android",
+    "x86_64-unknown-dragonfly",
+    "x86_64-unknown-freebsd",
+    "x86_64-unknown-illumos",
+    "x86_64-unknown-linux-gnu",
+    "x86_64-unknown-netbsd",
+    "x86_64-unknown-openbsd",
 ]
 
 # Shared dependencies for all platforms

README.md

@@ -5,7 +5,7 @@
 [![docs.rs](https://img.shields.io/badge/docs.rs-compio-latest)](https://docs.rs/compio)
 [![Azure DevOps builds](https://strawberry-vs.visualstudio.com/compio/_apis/build/status/Berrysoft.compio?branch=master)](https://strawberry-vs.visualstudio.com/compio/_build)
 
-A thread-per-core Rust runtime with IOCP/io_uring.
+A thread-per-core Rust runtime with IOCP/io_uring/mio.
 The name comes from "completion-based IO".
 This crate is inspired by [monoio](https://github.com/bytedance/monoio/).
 
@@ -22,6 +22,7 @@ and `tokio` won't public APIs to control `mio` before `mio` reaches 1.0.
 ## Quick start
 
 With `runtime` feature enabled, we can use the high level APIs to perform fs & net IO.
+
 ```rust,no_run
 use compio::{fs::File, task::block_on};
 
@@ -36,6 +37,7 @@ println!("{}", buffer);
 ```
 
 While you can also control the low-level driver manually:
+
 ```rust,no_run
 use compio::{
     buf::IntoInner,

src/driver/mod.rs

@@ -84,7 +84,8 @@ pub trait Poller {
     ///
     /// # Safety
     ///
-    /// `op` should be alive until [`Poller::poll`] returns its result.
+    /// - `op` should be alive until [`Poller::poll`] returns its result.
+    /// - `user_data` should be unique.
     unsafe fn push(&mut self, op: &mut (impl OpCode + 'static), user_data: usize)
     -> io::Result<()>;
 

src/driver/unix/mod.rs

@@ -1 +1,4 @@
+//! This mod doesn't actually contain any driver, but meant to provide some
+//! common op type and utilities for unix platform (for iour and mio).
+
 pub(crate) mod op;