#tokio #async #async-io #io

madsim-real-tokio

一个用于编写基于异步I/O的后端应用程序的事件驱动、非阻塞I/O平台

1个稳定版本

1.37.0 2024年4月8日

#298 in 异步

MIT许可证

3MB
44K SLoC

Tokio

使用Rust编程语言编写可靠、异步和精简应用程序的运行时。它是

  • 快速:Tokio的零成本抽象为你提供裸机性能。

  • 可靠:Tokio利用Rust的所有权、类型系统和并发模型来减少错误并确保线程安全。

  • 可扩展:Tokio具有最小的内存占用,并自然地处理背压和取消。

Crates.io MIT licensed Build Status Discord chat

网站 | 指南 | API文档 | 聊天

概述

Tokio是使用Rust编程语言编写异步应用程序的事件驱动、非阻塞I/O平台。从高层次来看,它提供了一些主要组件

  • 一个基于多线程、工作窃取的调度器
  • 由操作系统的事件队列(epoll、kqueue、IOCP等)支持的reactor。
  • 异步TCP和UDP套接字。

这些组件提供了构建异步应用程序所需的运行时组件。

示例

使用Tokio的基本TCP回声服务器。

确保在Cargo.toml中激活了tokio crate的完整功能

[dependencies]
tokio = { version = "1.37.0", features = ["full"] }

然后在main.rs中

use tokio::net::TcpListener;
use tokio::io::{AsyncReadExt, AsyncWriteExt};

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let listener = TcpListener::bind("127.0.0.1:8080").await?;

    loop {
        let (mut socket, _) = listener.accept().await?;

        tokio::spawn(async move {
            let mut buf = [0; 1024];

            // In a loop, read data from the socket and write the data back.
            loop {
                let n = match socket.read(&mut buf).await {
                    // socket closed
                    Ok(n) if n == 0 => return,
                    Ok(n) => n,
                    Err(e) => {
                        eprintln!("failed to read from socket; err = {:?}", e);
                        return;
                    }
                };

                // Write the data back
                if let Err(e) = socket.write_all(&buf[0..n]).await {
                    eprintln!("failed to write to socket; err = {:?}", e);
                    return;
                }
            }
        });
    }
}

更多示例可以在这里找到。对于更大的“真实世界”示例,请参阅mini-redis存储库。

要查看可以启用的可用功能标志列表,请参阅我们的文档

获取帮助

首先,查看您的问题是否可以在指南API文档中找到。如果没有找到答案,Tokio Discord服务器中有一个活跃的社区。我们很乐意尝试回答您的问题。您还可以在讨论页面上提出您的问题。

贡献

🎈 感谢您对项目的改进贡献!我们非常高兴有您加入!我们有一个贡献指南,帮助您参与Tokio项目。

除了这个仓库中的crates,Tokio项目还维护了其他几个库,包括

  • axum:一个注重人体工程学和模块化的Web应用程序框架。

  • hyper:为Rust提供的快速且正确的HTTP/1.1和HTTP/2实现。

  • tonic:一个专注于高性能、互操作性和灵活性的gRPC over HTTP/2实现。

  • warp:一个超级简单、可组合的,高速Web服务器框架。

  • tower:一个用于构建健壮的网络客户端和服务器模块化和可重用组件的库。

  • tracing(以前称为tokio-trace):一个用于应用程序级跟踪和异步感知诊断的框架。

  • mio:一个跨平台的低级抽象,覆盖OS I/O API,为tokio提供动力。

  • bytes:用于处理字节的高效字节缓冲区实用程序。

  • loom:一个用于并发Rust代码的测试工具。

变更日志

Tokio仓库包含多个crates。每个crates都有自己的变更日志。

支持的Rust版本

Tokio将保持至少6个月的滚动MSRV(最低支持Rust版本)政策。当提高MSRV时,新的Rust版本必须至少发布6个月。当前的MSRV是1.63。

请注意,MSRV不会自动提高,仅作为次要版本发布的一部分。过去次要版本中MSRV的历史记录如下

  • 1.30到至今 - Rust 1.63
  • 1.27到1.29 - Rust 1.56
  • 1.17到1.26 - Rust 1.49
  • 1.15到1.16 - Rust 1.46
  • 1.0到1.14 - Rust 1.45

请注意,尽管我们试图避免Tokio的依赖关系间接提高MSRV的情况,但我们不能保证这种情况不会发生。然而,每个次要版本都将有一些与该次要版本MSRV兼容的依赖关系版本。

发布计划

Tokio不遵循固定的发布计划,但我们通常每月发布一到两个新的次要版本。当需要时,我们会发布补丁版本以修复错误。

错误修补政策

为了制作包含错误修复的补丁版本,我们已经指定了某些次要版本作为LTS(长期支持)版本。每当有错误需要修补版本来修复错误时,它将被回滚并作为每个LTS次要版本的新补丁版本发布。我们当前的LTS版本是

  • 1.32.x - 2024年9月前的LTS版本。(MSRV 1.63)
  • 1.36.x - 2025年3月前的LTS版本。(MSRV 1.63)

每个LTS版本将持续至少一年接收回滚的修复。如果您想在项目中使用固定的小版本,我们建议您使用LTS版本。

要使用固定的小版本,您可以使用波浪线指定版本。例如,要指定使用最新的 1.32.x 补丁版本,您可以使用以下依赖规范

tokio = { version = "~1.32", features = [...] }

以前的LTS版本

  • 1.8.x - 2022年2月前的LTS版本。
  • 1.14.x - 2022年6月前的LTS版本。
  • 1.18.x - 2023年6月前的LTS版本。
  • 1.20.x - 2023年9月前的LTS版本。
  • 1.25.x - 2024年3月前的LTS版本。

许可证

此项目遵循MIT许可证

贡献

除非您明确说明,否则您提交给Tokio的任何有意包含的贡献都应按照MIT许可证进行许可,不附加任何额外条款或条件。

依赖项

~0-12MB
~90K SLoC