构建脚本共享的临时目录

此crate公开一个编译时临时目录，该目录可以在构建图中由多个crate共享，并由cargo clean删除。

预期使用方式是从build.rs Cargo构建脚本中，或者更有可能是从被其他crate构建脚本调用的库中。

# Cargo.toml

[build-dependencies]
scratch = "1.0"

// build.rs

fn main() {
    let dir = scratch::path("mycrate");
    // ... write or read inside of that path
}

比较

与 std::env::var_os("OUT_DIR") 的比较

• 此功能与OUT_DIR的不同之处在于，所有通过匹配的 suffix 参数进行构建的crate都将看到相同的目录路径，并且每个crate都可以看到其他crate的构建脚本已经放入该目录的内容。

• 此功能与OUT_DIR相似之处在于，两者在执行 cargo clean 时都会被删除。

与 std::env::temp_dir() 的比较

• 此功能与temp_dir()相似之处在于，放入其中的内容对随后运行的构建脚本可见。

• 此功能与temp_dir()的不同之处在于，cargo clean 会清理内容。

提示

当Cargo运行多个并发构建脚本且访问相同的临时目录时，您需要考虑会发生什么。在某些用例中，您可能需要对临时目录的内容进行一些同步，例如通过一个咨询性的文件锁。在类Unix和Windows主机系统上，按顺序排列构建脚本，以便每个脚本在下一个脚本访问之前都获得独占访问权限的最简单方法是

use std::fs::File;
use std::io;

fn main() -> io::Result<()> {
    let dir = scratch::path("demo");
    let flock = File::create(dir.join(".lock"))?;
    fs2::FileExt::lock_exclusive(&flock)?;

    // ... now do work
}

这种最简单的方法对于填充缓慢（可能是一个大下载）但使用快速/几乎立即的缓存来说是不错的。另一方面，如果使用您的缓存的构建脚本即使只从临时目录中读取也需要一段时间才能完成，那么允许读者并行进步的不同方法将表现得更好。

use std::fs::{self, File};
use std::io;

fn main() -> io::Result<()> {
    let dir = scratch::path("demo");
    let flock = File::create(dir.join(".lock"))?;
    let sdk = dir.join("thing.sdk");

    if !sdk.exists() {
        fs2::FileExt::lock_exclusive(&flock)?;
        if !sdk.exists() {
            let download_location = sdk.with_file_name("thing.sdk.partial");
            download_sdk_to(&download_location)?;
            fs::rename(&download_location, &sdk)?;
        }
        fs2::FileExt::unlock(&flock)?;
    }

    // ... now use the SDK
}

对于不仅仅是第一个构建脚本写入目录而其余脚本读取目录的情况，可以考虑更复杂的方案，这可能包括使用lock_shared。

许可