# async-io

**Repository Path**: iot-ua/async-io

## Basic Information

- **Project Name**: async-io
- **Description**: 异步io，内部使用操作系统提供的异步模型EPOLL/IOCP进行实现。
- **Primary Language**: Rust
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-06-24
- **Last Updated**: 2023-02-03

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# async-io

#### 1. 介绍
异步io，内部使用操作系统提供的异步模型`EPOLL/IOCP`进行实现。

### 2.编译指南

#### 2.1. 编译环境准备

1. 安装 `Rust`。通过 `rustup` 下载 `Rust`，这是一个管理 `Rust` 版本和相关工具的命令行工具。
2. 安装 `Rust` 编译器 。本项目采用的编译器是 `rustc 1.61.0-nightly` 。这里需要强调的是 `nightly` 版本的是官方用来实验新功能的 **不稳定版本** 。此项目用到了很多 `Rust` 的 **不稳定特性**，因此只能选择 `nightly`。
3. 安装 `Cargo`，这是 `Rust` 的构建系统和包管理器，大多数 `Rustacean` 们使用 `Cargo` 来管理他们的 `Rust` 项目，它可以帮你处理很多任务，比如构建代码，下载依赖库并编译这些库。
4. 使用 `Cargo` 编译本项目。`cargo build` 编译一个包，`cargo check` 检查本地包及其所有依赖项是否有错误，`cargo clean` 删除 `Cargo` 过去生成的文件。`cargo build --release` 表示构建带有优化的包。

#### 2.2. 项目目录结构说明

- `async-io`
  - `examples`  示例代码
  - `src` 
    - `net`
      - `sys`
        - `unix` 基于 `unix` 系统的 `socket `和 `epoll` 的实现
    - reactor  异步 `io` 反应器实现
    - driver    阻塞执行 `Future` 的 `block_on` 实现

#### 2.3. 条件编译

##### 2.3.1. 通过配置 `Cargo.toml` 配置文件可以实现条件编译

``` toml
[features]
# default 字段配置了默认启动哪些 feature。每一个 feature 都是一个列表，列表中的项表示将依赖于哪些 feature。
# default = ["alloc", "single_thread"] 表示默认依赖于 alloc 和 signle_thread 。而 alloc 又依赖于 "async-executor/alloc", "async-task/alloc" 库，默认为 NO-STD 编译。
# 若将 default = ["alloc"] 修改为 default = ["std"] 则表示依赖依赖项中包含 rust STD。
# 注意事项：不能同时开启 alloc 和 std。编译时只能选择其中一个。即 default = ["alloc","std"] 是错误的，无法编译。
default = ["alloc", "single_thread"]
alloc = ["async-executor/alloc", "async-task/alloc"]
std = ["stdlib/std", "async-executor/std", "async-task/std"]
single_thread = ["async-executor/single_thread", "async-task/single_thread"]
multiple_thread = [
  "async-executor/multiple_thread",
  "async-task/multiple_thread",
]
```

##### 2.3.2. 通过`Cargo`命令实现条件编译

```shell
# 注意事项：不能同时开启 alloc 和 std。编译时只能选择其中一个。即 cargo build --no-default-features --features "signle_thread alloc std" 是错误的，无法编译。
# STD 编译
# --no-default-features 表示不开启默认 features ，--features "std single_thread" 会依赖用户列出的 features，也就是 std 和 single_thread。
cargo build --no-default-features --features "std single_thread"
# NO-STD
# --no-default-features 表示不开启默认 features ，--features "signle_thread alloc" 会依赖用户列出的 features，也就是signle_thread 和 alloc。
cargo build --no-default-features --features "single_thread alloc"
```