Baike.dev
All toolsOnline toolsAI codingTrendingOpen sourceNewsSubmit
Log in
< Back to tools
D

displaydoc

> 编程语言
Open source

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

365 stars0 likes0 views
WebsiteGitHub

About

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

derive(Display) /// From

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

toml
[dependencies]
displaydoc = "0.2"

Compiler support: requires rustc 1.71+

Example

Demonstration alongside the [Error][std::error::Error] derive macro from thiserror, to propagate source locations from [io::Error][std::io::Error] with the #[source] attribute:

…

Note that although [io::Error][std::io::Error] implements Display, we do not add it to the generated message for DataStoreError::Disconnect, since it is already made available via #[source]. See further context on avoiding duplication in error reports at the rust blog here.

Details

  • A fmt::Display impl is generated for your enum if you provide a docstring comment on each variant as shown above in the example. The Display derive macro supports a shorthand for interpolating fields from the error:
    • /// {var} ⟶ write!("{}", self.var)
    • /// {0} ⟶ write!("{}", self.0)
    • /// {var:?} ⟶ write!("{:?}", self.var)
    • /// {0:?} ⟶ write!("{:?}", self.0)
  • This also works with structs and [generic types][crate::Display#generic-type-parameters]:
rust
/// oh no, an error: {0}
#[derive(Display)]
pub struct Error(pub E);

let error: Error = Error("muahaha i am an error");
assert!("oh no, an error: muahaha i am an error" == &format!("{}", error));
  • Two optional attributes can be added to your types next to the derive:

    • #[ignore_extra_doc_attributes] makes the macro ignore any doc comment attributes (or /// lines) after the last non-empty line. Multi-line comments with line breaks using /// are otherwise treated as an error, so use this attribute or consider switching to block doc comments (/** */).

    • #[prefix_enum_doc_attributes] combines the doc comment message on your enum itself with the messages for each variant, in the format “enum: variant”. When added to an enum, the doc comment on the enum becomes mandatory. When added to any other type, it has no effect.

  • In case you want to have an independent doc comment, the #[displaydoc("...") attribute may be used on the variant or struct to override it.

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.

Issues· 0 open

View all issuesOpen on GitHub

No open issues yet, or sync has not completed.

> Tags

Rust

No comments yet. Be the first to share.

> Details

PublishedAug 1, 2026
UpdatedSep 17, 2026
Category编程语言
PricingOpen source

> Related tools

T
TypeScript
JavaScript 的超集,为前端与全栈提供静态类型
P
Python
通用编程语言,广泛用于 Web、数据与 AI
G
Go
Google 推出的简洁高效系统语言