camino - UTF-8路径处理库

在编程世界里，路径处理是一个至关重要的任务，尤其是在跨平台的开发中。而camino是一个精心设计的Rust库，专为那些希望确保其路径操作始终安全并以UTF-8编码进行的开发者打造。它扩展了标准库中的std::path模块，引入了新的Utf8PathBuf和Utf8Path类型。

camino是什么？

camino的核心是两个新类型——Utf8PathBuf和Utf8Path。它们类似于std::path::PathBuf和std::path::Path，但保证只存储UTF-8编码的数据。这意味着你可以像处理字符串一样处理它们，它们实现了Display等特性。

与标准库的Path类型不同，std::path并不保证路径的UTF-8合法性。然而，在所有平台上，非Unicode路径非常罕见，主要是因为：

1. Unicode已成为标准，许多遗留代码已转换。
2. 在Windows和Unix上，Unicode是共同支持的路径格式。
3. 很多系统（如Cargo）只支持UTF-8路径，如果你的工具与其交互，你可以假设路径是UTF-8的。
4. 使用非UTF-8路径时会遇到"makefile问题"，这是一个跨平台无解的问题。

因此，camino允许你一次检查路径是否为UTF-8，然后在其后的所有操作中都将其视为有效的UTF-8路径，避免了重复且可能出错的转换。

示例与API设计

在Utf8PathBuf和Utf8Path的文档中，你可以找到各种使用示例。此外，camino-examples目录提供了一些与其他库（如serde和clap）结合使用的示例。

camino的设计尽量接近std::path。Utf8Path和Utf8PathBuf是Path和PathBuf的直接替代品。大部分API保持一致，但在与str交互的地方有所不同，例如Path::to_str()重命名为Utf8Path::as_str()，Utf8Path实现了Display，Path::display()被移除，并且迭代Utf8Path返回&str而不是&OsStr。

每个Utf8Path都是一个合法的Path，因此Utf8Path实现了AsRef<Path>，所有接受impl AsRef<Path>的API都可以继续与Utf8Path实例一起工作。

何时使用camino？

camino以牺牲某些便利性换取简洁性。你是否应该使用camino，取决于具体项目需求。以下是一些指导原则：

你应该考虑使用camino的情况包括：

1. 构建可移植的跨平台软件。
2. 你的系统有包含其他文件名称的文件。
3. 与已经假设UTF-8路径的现有系统交互。
4. 正在构建全新项目，并愿意要求用户如果必要时重新命名他们的路径。

你不应使用camino的情况包括：

1. 编写核心系统实用程序。
2. 有遗留兼容性约束。
3. 有其他需要支持非UTF-8路径的理由。

可选功能与Rust版本支持

camino默认没有任何依赖项，除了std。还有一些可选特性，如启用serde1添加对Utf8PathBuf和Utf8Path的序列化和反序列化的支持，以及启用proptest1添加proptest的Arbitrary实现。

camino的最低支持Rust版本（MSRV）是1.34。该项目在最新稳定版Rust和MSRV下都有测试。

许可证

camino项目遵循Apache 2.0或MIT许可条款。

小结

camino是一个理想的路径处理库，适合希望在跨平台场景中保持路径统一性的开发者。它的简洁设计和强大功能使其成为处理UTF-8路径的理想选择。如果你的项目涉及到大量的路径操作，尤其是跨平台的情况下，不妨尝试一下camino，它将为你带来更顺畅的开发体验。