diff options
Diffstat (limited to 'vendor/derivative/README.md')
-rw-r--r-- | vendor/derivative/README.md | 55 |
1 files changed, 55 insertions, 0 deletions
diff --git a/vendor/derivative/README.md b/vendor/derivative/README.md new file mode 100644 index 000000000..36e998aa7 --- /dev/null +++ b/vendor/derivative/README.md @@ -0,0 +1,55 @@ +# Derivative + +[![Crates.io](https://img.shields.io/crates/v/derivative.svg?maxAge=3600)](https://crates.io/crates/derivative) +[![Crates.io](https://img.shields.io/crates/l/derivative.svg?maxAge=3600)](https://github.com/mcarton/rust-derivative#license) +![Continuous integration](https://github.com/mcarton/rust-derivative/workflows/Continuous%20integration/badge.svg) + +This crate provides a set of alternative customizable `#[derive]` attributes for Rust. + +## [Documentation][documentation] +## Stability + +This crate is stable and follows semver. It requires *rustc 1.34 or later* and changing the minimal rustc version will be considered a semver breaking change. + +## What it does + +```rust +#[derive(Derivative)] +#[derivative(Debug)] +struct Foo { + foo: u8, + #[derivative(Debug="ignore")] + bar: u8, +} + +// Prints `Foo { foo: 42 }` +println!("{:?}", Foo { foo: 42, bar: 1 }); +``` + +Check the [documentation] for more! + +## License + +Licensed under either of + * Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or + <http://www.apache.org/licenses/LICENSE-2.0>) + * MIT license ([LICENSE-MIT](LICENSE-MIT) or <http://opensource.org/licenses/MIT>) + +at your option. + +## Acknowledgements + +This is inspired from how [`serde`] wonderfully handles attributes. +This also takes some code and ideas from `serde` itself. + +Some tests are directly adapted from `rustc`'s tests. + +## Contribution + +Unless you explicitly state otherwise, any contribution intentionally submitted +for inclusion in the work by you, as defined in the Apache-2.0 license, shall +be dual licensed as above, without any additional terms or conditions. + +[`serde`]: https://crates.io/crates/serde +[documentation]: https://mcarton.github.io/rust-derivative/latest/index.html +[rustc]: https://github.com/rust-lang/rust |