Tungstenite-rs 项目教程

Tungstenite-rs 项目教程

tungstenite-rsLightweight stream-based WebSocket implementation for Rust.项目地址:https://gitcode.com/gh_mirrors/tu/tungstenite-rs

1. 项目的目录结构及介绍

tungstenite-rs/
├── Cargo.toml
├── src/
│   ├── client.rs
│   ├── error.rs
│   ├── handshake/
│   │   ├── client.rs
│   │   ├── mod.rs
│   │   └── server.rs
│   ├── lib.rs
│   ├── protocol/
│   │   ├── message.rs
│   │   ├── mod.rs
│   │   └── web_socket.rs
│   ├── stream.rs
│   └── util.rs

• Cargo.toml: 项目的依赖和元数据配置文件。
• src/: 源代码目录。
  • client.rs: 客户端相关功能。
  • error.rs: 错误处理模块。
  • handshake/: WebSocket 握手处理模块。
    • client.rs: 客户端握手处理。
    • mod.rs: 模块声明文件。
    • server.rs: 服务器握手处理。
  • lib.rs: 库的入口文件。
  • protocol/: WebSocket 协议处理模块。
    • message.rs: WebSocket 消息处理。
    • mod.rs: 模块声明文件。
    • web_socket.rs: WebSocket 核心协议实现。
  • stream.rs: 流处理模块。
  • util.rs: 工具函数和辅助模块。

2. 项目的启动文件介绍

src/lib.rs 是项目的入口文件，它导入了其他模块并提供了库的公共接口。以下是 lib.rs 的部分内容：

pub mod client;
pub mod error;
pub mod handshake;
pub mod protocol;
pub mod stream;
pub mod util;

pub use crate::error::{Error, Result};
pub use crate::protocol::{Message, WebSocket};
pub use crate::client::{client, connect, ClientRequestBuilder};
pub use crate::handshake::{ClientHandshake, ServerHandshake, HandshakeError};

3. 项目的配置文件介绍

Cargo.toml 是 Rust 项目的配置文件，包含了项目的依赖、版本和其他元数据。以下是 Cargo.toml 的部分内容：

[package]
name = "tungstenite"
version = "0.23.0"
edition = "2018"

[dependencies]
byteorder = "1.3.2"
bytes = "1.0"
data-encoding = "2.0"
http = { version = "1.0", optional = true }
httparse = { version = "1.3.4", optional = true }
log = "0.4.8"
native-tls = "0.2.3"
rand = "0.8.0"
rustls = "0.23.0"
url = "2.1.0"
webpki-roots = "0.26"

[dev-dependencies]
criterion = "0.5.0"
env_logger = "0.10.0"
input_buffer = "0.5.0"
rand = "0.8.4"
socket2 = "0.5.5"

这个文件定义了项目的名称、版本和依赖库。dependencies 部分列出了项目运行所需的库，而 dev-dependencies 部分列出了开发和测试时所需的库。

tungstenite-rsLightweight stream-based WebSocket implementation for Rust.项目地址:https://gitcode.com/gh_mirrors/tu/tungstenite-rs