displaydoc

by yaahc

yaahc / displaydoc

A derive macro for implementing the display Trait via a doc comment and string interpolation

234 Stars 5 Forks Last release: Not found Other 41 Commits 0 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

derive(Display) ///
From

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. Just add
      default-features = false
      .
  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.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.