Skip to content
A derive macro for implementing the display Trait via a doc comment and string interpolation
Rust
Branch: master
Clone or download
Latest commit 8d277d6 Nov 14, 2019

README.md

derive(Display) /// From<docs>

Latest Version Rust Documentation

This library provides a convenient derive macro for the standard library's core::fmt::Display trait.

[dependencies]
displaydoc = "0.1"

Compiler support: requires rustc 1.31+


Example

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,
}

Details

  • A Display impl is generated for your type if you provide doc comment messages on the struct or each variant of your enum, as shown above in the example.

    The messages support a shorthand for interpolating fields from the error.

    • /// {var}write!("{}", self.var)
    • /// {0}write!("{}", self.0)
    • /// {var:?}write!("{:?}", self.var)
    • /// {0:?}write!("{:?}", self.0)

FAQ

  1. Is this crate no_std compatible?

    • Yes! This crate implements the core::fmt::Display trait not the std::fmt::Display trait so it should work in std and no_std environments.
  2. Does this crate work with Path and PathBuf via the Display trait?

    • Yuuup. This crate uses @dtolnay's autoref specialization technique to add a special trait for types to get the display impl, it then specializes for Path and PathBuf and when either of these types are found it calls self.display() to get a std::path::Display<'_> type which can be used with the Display format specifier!

License

Licensed under either of Apache License, Version 2.0 or MIT license at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this crate by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
You can’t perform that action at this time.