path_no_alloc：一个用于栈分配路径的舒适库

最近我开始开发一个非常依赖路径操作的库。在与充斥着 Path.join 调用的函数打交道之后，我想要一个更快、更舒适的解决方案。肯定有更好的方法，对吧？

这就是 path_no_alloc 的作用。它是一个简单的库，用于连接和使用路径，同时避免对小于 128 字节的短路径进行分配。

使用非常简单。在 with_paths! 内部，路径使用 / 运算符连接，如果路径的总长度小于 128 字节，操作将在栈分配的缓冲区内部进行。

use path_no_alloc::with_paths;

let p1 = "hello";
let p2 = "world";

// Here, we create a variable `path` of type `&Path` that
// represents p1 joined to p2
with_paths! {
    path = p1 / p2
};

assert_eq!(path, std::path::Path::new("hello/world"));

with_paths! 也可以用作复合表达式，通过使用 => 运算符在声明后附加语句

use path_no_alloc::with_paths;

let p1 = "some/dir";
let p2 = "file.txt";

let file_exists: bool = with_paths! {
    path = p1 / p2 => path.exists()
};

在 with_paths! 块内部可以有无限数量的语句，也可以创建和连接任意数量的路径。任何实现了 AsRef<Path> 的类型都可以用于声明并连接到其他路径。

use path_no_alloc::with_paths;
use std::path::{Path, PathBuf};

let p1 = Path::new("hello");
let p2 = "world".to_string();
let my_file = "file.txt";
let some_root = PathBuf::from("some/project/root");

let path_exists = with_paths! {
    path = p1 / p2,
    another_path = some_root / p1 / my_file,
    some_third_path = p1 / p2 / some_root / my_file

    =>

    assert_eq!(path, std::path::Path::new("hello/world"));
    assert_eq!(another_path, std::path::Path::new("some/project/root/hello/file.txt"));
    let path_exists = some_third_path.exists();
    println!("{some_third_path:?} exists? {path_exists}");

    path_exists
};

最后，在 with_paths! 块中连接的路径的行为与使用 Path.join 连接的路径完全相同。这意味着将绝对路径与其他路径连接将截断并仅返回绝对路径

use path_no_alloc::with_paths;
use std::path::Path;

let working_dir = "my/working/dir";
let rel_path = "path/to/file.txt";
let abs_path = "/path/to/file.txt";

with_paths! {
    relative = working_dir / rel_path,
    absolute = working_dir / abs_path
};

// Joining a relative path appends it
assert_eq!(relative, Path::new("my/working/dir/path/to/file.txt"));
// But joining an absolute path just results in the absolute path
assert_eq!(absolute, Path::new("/path/to/file.txt"));

// this is the same as the behavior of Path.join():
assert_eq!(relative, Path::new(working_dir).join(rel_path));
assert_eq!(absolute, Path::new(working_dir).join(abs_path));

细节

性能

在测试了 131072 个随机路径后，使用 with_paths! 宏比调用 Path.join() 快 2-3.5 倍，且这是在理想条件下 Path.join。分配本质上是非确定的；它受到多个线程的竞争；并且在某些特定延迟的应用程序上下文中必须完全避免。