displaydoc-lite 0.1.0

Implement the Display trait using your standard doc comments.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47

`displaydoc-lite`
=================
[![Crates.io](https://img.shields.io/crates/v/displaydoc-lite.svg)](https://crates.io/crates/displaydoc-lite)
[![Documentation](https://img.shields.io/badge/documentation-docs.rs-blue.svg)](https://docs.rs/displaydoc-lite)

**Implement the `Display` trait using your standard doc comments.**

This crate is a lite version of the popular crate [`displaydoc`][ddoc].
It provides the same functionality but using a declarative macro instead
and not depending on `syn` or `quote`.

This crate is also usable in `no_std` environments. No additional features are required for that.

Note: `displaydoc-lite` still has a proc-macro as a dependency,
but it's very tiny and doesn't have any dependencies.

## Example

```rust
use displaydoc_lite::displaydoc;

displaydoc! {
    #[derive(Debug)]
    pub enum DataStoreError {
        /// data store disconnected
        Disconnect,
        /// the data for key is not available
        Redaction,
        /// invalid header
        InvalidHeader,
        /// unknown data store error
        Unknown,
    }
}
```

Support for interpolating fields is planed, but currently not implemented.


### License

Licensed under either [Apache License][apache] or the [MIT][mit] license.


[apache]: https://github.com/Stupremee/displaydoc-lite/tree/main/LICENSE-APACHE
[mit]: https://github.com/Stupremee/displaydoc-lite/tree/main/LICENSE-MIT
[ddoc]: https://crates.io/crates/displaydoc