如何在Rust中的IO错误中包含文件路径？

Question

在这个极简主义的程序中，我希望file_size函数在/not/there中包含路径Err，以便它可以在main函数中显示：

use std::fs::metadata;
use std::io;
use std::path::Path;
use std::path::PathBuf;

fn file_size(path: &Path) -> io::Result<u64> {
    Ok(metadata(path)?.len())
}

fn main() {
    if let Err(err) = file_size(&PathBuf::from("/not/there")) {
        eprintln!("{}", err);
    }
}

Answer 1

您必须定义自己的错误类型才能包装此附加数据。

就个人而言，我喜欢使用custom_error箱子，因为它对于处理几种类型特别方便。在您的情况下，它可能看起来像这样：

use custom_error::custom_error;
use std::fs::metadata;
use std::io;
use std::path::{Path, PathBuf};
use std::result::Result;

custom_error! {ProgramError
    Io {
        source: io::Error,
        path: PathBuf
    } = @{format!("{path}: {source}", source=source, path=path.display())},
}

fn file_size(path: &Path) -> Result<u64, ProgramError> {
    metadata(path)
        .map(|md| md.len())
        .map_err(|e| ProgramError::Io {
            source: e,
            path: path.to_path_buf(),
        })
}

fn main() {
    if let Err(err) = file_size(&PathBuf::from("/not/there")) {
        eprintln!("{}", err);
    }
}

输出：

/not/there: No such file or directory (os error 2)

Answer 2

虽然Denys Séguret's answer是正确的，我喜欢使用我的箱子SNAFU，因为它提供了context的概念。这使得附加路径（或其他任何东西！）的行为非常容易：

use snafu::{ResultExt, Snafu}; // 0.2.3
use std::{
    fs, io,
    path::{Path, PathBuf},
};

#[derive(Debug, Snafu)]
enum ProgramError {
    #[snafu(display("Could not get metadata for {}: {}", path.display(), source))]
    Metadata { source: io::Error, path: PathBuf },
}

fn file_size(path: impl AsRef<Path>) -> Result<u64, ProgramError> {
    let path = path.as_ref();
    let md = fs::metadata(&path).context(Metadata { path })?;
    Ok(md.len())
}

fn main() {
    if let Err(err) = file_size("/not/there") {
        eprintln!("{}", err);
    }
}