制作Rust crate时如何指定非源代码类依赖数据？

在开发依赖图片、CSV、二进制可执行文件、着色器等非源代码数据的Rust crate时，可通过以下几种方案解决路径定位问题：

1. 直接嵌入数据到二进制文件 #

适合体积较小的文件，利用Rust内置宏include_str!（文本文件）或include_bytes!（二进制文件）将数据直接编译进可执行文件，完全规避路径查找问题。

示例：

// 嵌入文本格式的CSV文件
static CSV_DATA: &str = include_str!("data/sample.csv");
// 嵌入二进制格式的图片文件
static IMAGE_DATA: &[u8] = include_bytes!("assets/icon.png");

fn main() {
    // 使用CSV数据
    println!("CSV内容片段：{}", CSV_DATA.lines().next().unwrap());
    // 使用图片数据（以image库为例）
    let image = image::load_from_memory(IMAGE_DATA).unwrap();
    println!("图片尺寸：{}x{}", image.width(), image.height());
}

注：文件路径为相对于当前源代码文件的路径，Cargo构建时会自动解析。

2. 从可执行文件路径推导数据目录 #

如果数据需要单独分发（如大型二进制、多文件资源包），可通过当前可执行文件的位置定位数据目录，确保在任意安装环境下都能找到资源。

示例：

use std::path::PathBuf;

fn get_data_root() -> PathBuf {
    // 获取当前可执行文件的绝对路径
    let exe_path = std::env::current_exe().expect("无法读取可执行文件路径");
    // 假设数据目录与可执行文件同级，名为"data"
    exe_path.parent().unwrap().join("data")
}

fn main() {
    let shader_path = get_data_root().join("shaders/main.glsl");
    let shader_content = std::fs::read_to_string(shader_path).unwrap();
    println!("着色器内容：\n{}", shader_content);
}

3. 开发阶段利用CARGO_MANIFEST_DIR #

在本地开发调试时，可使用Cargo提供的CARGO_MANIFEST_DIR环境变量，它指向当前crate的根目录，方便直接引用源码目录下的资源文件。

示例：

// 编译时获取crate根目录路径
static CRATE_ROOT: &str = env!("CARGO_MANIFEST_DIR");

fn main() {
    let csv_path = PathBuf::from(CRATE_ROOT).join("data/sample.csv");
    let csv_content = std::fs::read_to_string(csv_path).unwrap();
    println!("CSV内容：{}", csv_content);
}

注：env!宏在编译时展开，该路径为编译时的crate根目录，发布后可能不适用，仅适合开发调试场景。

4. 通过构建脚本（build.rs）管理资源 #

对于需要复制到构建输出目录的资源，可编写build.rs脚本自动处理文件复制，并生成路径常量供主代码引用。

步骤1：编写build.rs复制资源并传递路径

use std::fs;
use std::path::Path;

fn main() {
    // 定义资源源目录和输出目录
    let src_dir = Path::new(env!("CARGO_MANIFEST_DIR")).join("assets");
    let dst_dir = Path::new(&std::env::var("OUT_DIR").unwrap()).join("assets");
    
    // 创建输出目录并复制所有资源文件
    fs::create_dir_all(&dst_dir).unwrap();
    for entry in fs::read_dir(src_dir).unwrap() {
        let entry = entry.unwrap();
        let dst_path = dst_dir.join(entry.file_name());
        fs::copy(entry.path(), dst_path).unwrap();
    }
    
    // 将资源目录路径传递给主代码
    println!("cargo:rustc-env=ASSETS_DIR={}", dst_dir.display());
}

步骤2：主代码中使用生成的路径

fn main() {
    let assets_dir = std::env::var("ASSETS_DIR").expect("无法获取资源目录路径");
    let binary_path = PathBuf::from(assets_dir).join("external_tool");
    // 执行外部二进制文件
    std::process::Command::new(binary_path).spawn().unwrap();
}

5. 静态哈希映射管理多资源（可选） #

如果需要管理大量小型资源，可使用phf crate生成编译时静态哈希映射，将文件名与嵌入的资源内容关联，实现快速查找。

首先在Cargo.toml添加依赖：

[dependencies]
phf = { version = "0.11", features = ["macros"] }

示例代码：

use phf::phf_map;

// 编译时生成资源映射表
static RESOURCES: phf::Map<&'static str, &'static [u8]> = phf_map! {
    "icon.png" => include_bytes!("assets/icon.png"),
    "sample.csv" => include_bytes!("data/sample.csv"),
    "main.glsl" => include_bytes!("shaders/main.glsl"),
};

fn main() {
    if let Some(shader_data) = RESOURCES.get("main.glsl") {
        let shader_content = String::from_utf8_lossy(shader_data);
        println!("着色器内容：\n{}", shader_content);
    }
}

内容的提问来源于stack exchange，提问作者Makogan