derive(Display) /// From<docs>

此库提供了一个方便的过程宏，用于实现标准库的 core::fmt::Display 特性。

[dependencies]
displaydoc = "0.2"

编译器支持：需要rustc 1.56+

示例

与 Error 过程宏（来自 thiserror）一起演示，以通过具有 #[source] 属性的传播源位置

use std::io;
use displaydoc::Display;
use thiserror::Error;

#[derive(Display, Error, Debug)]
pub enum DataStoreError {
    /// data store disconnected
    Disconnect(#[source] io::Error),
    /// the data for key `{0}` is not available
    Redaction(String),
    /// invalid header (expected {expected:?}, found {found:?})
    InvalidHeader {
        expected: String,
        found: String,
    },
    /// unknown data store error
    Unknown,
}

let error = DataStoreError::Redaction("CLASSIFIED CONTENT".to_string());
assert!("the data for key `CLASSIFIED CONTENT` is not available" == &format!("{}", error));

请注意，尽管 io::Error 实现了 Display，但我们没有将其添加到为 DataStoreError::Disconnect 生成的消息中，因为它已经通过 #[source] 提供了。有关避免错误报告中重复的更多上下文，请参阅 Rust 博客 此处。

详细信息

• 如果您像示例中那样为枚举的每个变体提供文档字符串注释，将为您的枚举生成一个 fmt::Display 实现如果您提供文档字符串注释
  • /// {var} ⟶ write!("{}", self.var)
  • /// {0} ⟶ write!("{}", self.0)
  • /// {var:?} ⟶ write!("{:?}", self.var)
  • /// {0:?} ⟶ write!("{:?}", self.0)
• 这也可以与结构和 泛型类型一起使用

/// oh no, an error: {0}
#[derive(Display)]
pub struct Error<E>(pub E);

let error: Error<&str> = Error("muahaha i am an error");
assert!("oh no, an error: muahaha i am an error" == &format!("{}", error));