displaydoc 0.1.4

A derive macro for implementing the display Trait via a doc comment and string interpolation
displaydoc-0.1.4 doesn't have any documentation.

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.4"

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.

License