PathBuf.to_string_lossy() 和 PathBuf.display().to_string() 在 Rust 中区别

PathBuf.to_string_lossy() 和 PathBuf.display().to_string() 在 Rust 中都用于将 PathBuf 转换为字符串，但它们之间存在一些关键区别，主要体现在以下几个方面：

1. 返回类型：

• to_string_lossy(): 返回 Cow<'_, str> 类型。Cow 是 “Clone on Write” 的缩写，它可以是借用 (&str) 或拥有 (String) 的字符串。这意味着如果路径已经是有效的 UTF-8 编码，to_string_lossy() 会尽可能借用底层数据，避免不必要的复制，从而提高效率。如果路径包含无效的 UTF-8 编码，它会创建一个新的 String，并将无效字符替换为 Unicode 替换字符 (U+FFFD)。
• display().to_string(): 返回 String 类型。display() 方法返回一个 Display 类型的值，该值旨在以适合用户友好的方式格式化路径。然后，.to_string() 方法将这个格式化后的路径转换为 String。display() 方法 假设 路径是有效的 UTF-8 编码。

2. 编码处理：

• to_string_lossy(): 容错性更强。它会检查路径是否为有效的 UTF-8 编码。
  • 有效 UTF-8: 如果路径是有效的 UTF-8，则返回路径的 UTF-8 字符串表示形式（Cow::Borrowed）。
  • 无效 UTF-8: 如果路径包含无效的 UTF-8 字节序列，则会将这些无效序列替换为 Unicode 替换字符 (U+FFFD, ) 并返回一个拥有所有权的 String (Cow::Owned)。这可以确保即使路径包含非 UTF-8 字符，程序也不会崩溃，而是以一种 “尽力而为” 的方式将其转换为字符串。
• display().to_string(): 假设路径是有效的 UTF-8。它不会进行任何编码检查或错误处理。如果路径包含无效的 UTF-8 字符，其行为是未定义的，可能会导致程序崩溃或产生乱码。在实践中，display() 可能会尝试以某种方式显示路径，即使它不是有效的 UTF-8，但这并不是其设计目的，也不应该依赖这种行为。

3. 使用场景：

• to_string_lossy():

  • 处理可能包含非 UTF-8 路径的情况: 当你处理的路径可能来自外部来源（例如用户输入、操作系统 API），并且你无法保证它们总是有效的 UTF-8 编码时，应该使用 to_string_lossy()。
  • 需要将路径转换为字符串，并希望程序在遇到无效字符时仍然能够正常运行: 即使路径包含无效字符，你仍然希望获得一个字符串表示形式，即使其中包含替换字符。
  • 性能敏感的场景: 在路径是有效 UTF-8 的情况下，to_string_lossy() 可以避免不必要的复制，提供更好的性能。

• display().to_string():

  • 主要用于用户界面显示或日志输出: display() 的目的是为了以用户友好的方式展示路径，例如在终端或 GUI 界面中显示。它会根据操作系统约定格式化路径。
  • 当你确信路径是有效的 UTF-8 编码时: 如果你确信你的程序只处理 UTF-8 编码的路径（例如，程序内部生成的路径），并且你只需要一个 String 类型的路径表示形式用于显示，可以使用 display().to_string()。但即使在这种情况下，为了代码的健壮性，也更推荐使用 to_string_lossy()。

总结：

示例：

use std::path::PathBuf;
use std::ffi::OsStr;

fn main() {
    // 假设我们有一个可能包含无效 UTF-8 字符的路径 (在某些操作系统上文件名可能不是 UTF-8)
    let path_bytes = b"foo\xffbar.txt"; // \xff 是无效的 UTF-8 字节
    let path_os_str = OsStr::from_bytes(path_bytes);
    let path_buf = PathBuf::from(path_os_str);

    // 使用 to_string_lossy()
    let lossy_string = path_buf.to_string_lossy();
    println!("to_string_lossy(): {}", lossy_string); // 输出：to_string_lossy(): foobar.txt ( 是替换字符)

    // 使用 display().to_string()
    let display_string = path_buf.display().to_string();
    println!("display().to_string(): {}", display_string); // 输出：display().to_string(): foobar.txt (输出可能因系统和终端而异，但通常也会显示替换字符，但行为未明确保证)
}

在上面的例子中，to_string_lossy() 明确地将无效的 UTF-8 字节 \xff 替换为了替换字符 ``，保证了返回一个有效的 String。而 display().to_string() 的行为虽然在这个例子中看起来相似，但在处理非 UTF-8 路径时，其行为可能是不确定的。

总结来说，为了代码的健壮性和通用性，尤其是在处理可能来自外部的路径时，PathBuf.to_string_lossy() 是更安全和推荐的选择。 PathBuf.display().to_string() 主要用于用户友好的显示场景，并且在你知道路径是有效 UTF-8 的情况下可以使用。