summaryrefslogtreecommitdiffstats
path: root/third_party/rust/smart-default/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'third_party/rust/smart-default/README.md')
-rwxr-xr-xthird_party/rust/smart-default/README.md40
1 files changed, 40 insertions, 0 deletions
diff --git a/third_party/rust/smart-default/README.md b/third_party/rust/smart-default/README.md
new file mode 100755
index 0000000000..226a9cbe14
--- /dev/null
+++ b/third_party/rust/smart-default/README.md
@@ -0,0 +1,40 @@
+[![Build Status](https://api.travis-ci.org/idanarye/rust-smart-default.svg?branch=master)](https://travis-ci.org/idanarye/rust-smart-default)
+[![Latest Version](https://img.shields.io/crates/v/smart-default.svg)](https://crates.io/crates/smart-default)
+[![Rust Documentation](https://img.shields.io/badge/api-rustdoc-blue.svg)](https://idanarye.github.io/rust-smart-default/)
+
+# Rust SmartDefault
+
+Custom derive for automatically implementing the `Default` trait with customized default values:
+
+```rust
+#[macro_use]
+extern crate smart_default;
+
+#[derive(SmartDefault)]
+enum Foo {
+ Bar,
+ #[default]
+ Baz {
+ #[default = 12]
+ a: i32,
+ b: i32,
+ #[default(Some(Default::default()))]
+ c: Option<i32>,
+ #[default(_code = "vec![1, 2, 3]")]
+ d: Vec<u32>,
+ #[default = "four"]
+ e: String,
+ },
+ Qux(i32),
+}
+
+assert!(Foo::default() == Foo::Baz {
+ a: 12,
+ b: 0,
+ c: Some(0),
+ d: vec![1, 2, 3],
+ e: "four".to_owned(),
+});
+```
+
+Requires Rust 1.30+ (for non-string values in attributes)