Static Web Server 开源项目使用文档

Static Web Server 开源项目使用文档

static-web-serverA cross-platform, high-performance and asynchronous web server for static files-serving. ⚡项目地址:https://gitcode.com/gh_mirrors/st/static-web-server

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

Static Web Server 项目的目录结构如下：

static-web-server/
├── Cargo.lock
├── Cargo.toml
├── README.md
├── src/
│   ├── bin/
│   │   └── main.rs
│   ├── config/
│   │   └── mod.rs
│   ├── handler/
│   │   └── mod.rs
│   ├── server/
│   │   └── mod.rs
│   └── main.rs
└── templates/
    └── index.html

目录结构介绍

• Cargo.lock 和 Cargo.toml: Rust 项目的依赖管理文件。
• README.md: 项目说明文档。
• src/: 源代码目录。
  • bin/: 可执行文件目录，包含 main.rs 启动文件。
  • config/: 配置文件模块。
  • handler/: 请求处理模块。
  • server/: 服务器模块。
  • main.rs: 主入口文件。
• templates/: 静态文件目录，包含 index.html 文件。

2. 项目的启动文件介绍

项目的启动文件位于 src/bin/main.rs，主要负责初始化服务器配置、启动服务器并处理请求。以下是启动文件的主要内容：

use static_web_server::Server;

fn main() {
    let server = Server::new("0.0.0.0:8080");
    server.run();
}

启动文件介绍

• use static_web_server::Server;: 引入服务器模块。
• main(): 主函数，程序入口点。
  • Server::new("0.0.0.0:8080"): 创建服务器实例，监听 0.0.0.0:8080 地址。
  • server.run(): 启动服务器。

3. 项目的配置文件介绍

项目的配置文件模块位于 src/config/mod.rs，主要负责读取和解析配置文件。以下是配置文件模块的主要内容：

pub struct Config {
    pub host: String,
    pub port: u16,
    pub static_dir: String,
}

impl Config {
    pub fn new(host: &str, port: u16, static_dir: &str) -> Self {
        Config {
            host: host.to_string(),
            port,
            static_dir: static_dir.to_string(),
        }
    }
}

配置文件介绍

• Config 结构体: 包含服务器的主机地址、端口和静态文件目录。
• new 方法: 用于创建 Config 实例，传入主机地址、端口和静态文件目录。

通过以上介绍，您可以更好地理解和使用 Static Web Server 开源项目。希望这份文档对您有所帮助！

static-web-serverA cross-platform, high-performance and asynchronous web server for static files-serving. ⚡项目地址:https://gitcode.com/gh_mirrors/st/static-web-server