为我的可写类型使用 fmt::Write 或 io::Write 特征？

Question

我有一个结构，可以通过一系列复杂的方法调用将其转换为文本，其中包含大量write! 来电。 此文本可以写入文件或调试日志。 我正在尝试决定是使用fmt::Write还是io::Write 。 我真的不能同时使用这两种方法，因为这样所有的写作方法都需要复制。

简化示例：

impl MyType {
    fn write_it(&self, writer: &mut impl ???) {
//                                       ^ fmt::Write or io::Write?
        self.write_header(writer);
        self.write_contents(writer);
        self.write_footer(writer);
    }

    fn write_header(&self, writer: &mut impl ???) {
        write!(writer, "...")
    }
    // and more...
}

fmt::Write的文档说，

...这类似于标准库的 io::Write 特征，但它仅适用于 libcore。

所以这让我相信我应该使用io::Write 。 这（显然）适用于像BufWriter这样的 I/O 类型。 serde_json 这样做似乎值得注意。

// if I use io::Write, I can do this
my_type.write_it(&mut BufWriter::new(File::create("my-file.txt")?)?;

我也想用我的format! 和类似的宏。 所以我需要实现Display 。 事实上， Display不是可以表示为String的类型的事实上的特征吗？

// I want to do this
println!("Contents:\n{}", my_type);

// or this
let mut s = String::new();
write!(s, "{}", my_type);

所以我想我将把我的实现与Display联系起来。 但问题是：

impl Display for MyType {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        self.write_it(f)?;
//                    ^ the trait `std::io::Write` is not implemented for `std::fmt::Formatter<'_>`
    }
}

我可以通过使用impl fmt::Write来解决这个问题，但是我失去了前面提到的 I/O 功能。 两种类型之间没有适配器（如果这是预期用途，我假设会有一个）。 所以我夹在两者之间。 我应该使用哪个特征？ 有没有一种惯用的方法来获得两者的功能？

编辑：适配器？

@ÖmerErden 建议创建一个如下所示的适配器。 我只是不确定什么条件会导致 UTF-8 转换失败。 只要我用 write 写有效的 UTF-8 就保证转换不会失败write! ? 这对我来说似乎太冒险了。

struct Adapter<'a> {
    f: &'a mut dyn fmt::Write,
}

impl<'a> io::Write for Adapter<'a> {
    fn write(&mut self, b: &[u8]) -> Result<usize, io::Error> {
        let s = str::from_utf8(b)
            .map_err(|_| io::Error::from(io::ErrorKind::Other))?;
        self.f.write_str(s)
            .map_err(|_| io::Error::from(io::ErrorKind::Other))?;
        Ok(b.len())
    }

    fn flush(&mut self) -> Result<(), io::Error> {
        Ok(())
    }
}

Answer 1

正确的做法是为您的类型实现Display ，而根本没有write_it方法。 理想情况下，您的header 、 content和footer也实现Display ，因为这样您可以编写如下内容：

impl Display for MyType {
    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
        write!(f, "{}{}{}", self.header, self.content, self.footer)
    }    
}

但是，如果这不可能，您仍然可以像在示例代码中那样手动编写实现。

实际上，Display 不是可以表示为 String 的类型的事实上的特征吗？

更准确地说， Display是可以写入某物的类型的事实上的特征。 将事物转换为字符串只是Display的众多用例之一，但它本身不会创建任何中间字符串。