aboutsummaryrefslogtreecommitdiff
path: root/rand/rand-derive/README.md
blob: 3d1fedbe7d6872a54dc3ba495eb4cf36a3c729dd (plain)
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
48
49
50
51
rand_macros
====

`#[derive(Rand)]` functionality for the `rand::Rand` trait.

## Usage
Add this to your `Cargo.toml`:

```toml
[dependencies]
rand = "0.4"
rand_macros = "0.2"
```

and this to your crate root:

```rust
extern crate rand;
#[macro_use]
extern crate rand_macros;
```

## Examples

`#[derive(Rand)]` can be used on any `struct` or `enum` where all fields/variants implement `rand::Rand`.

```rust
#[derive(Debug, Rand)]
struct Foo {
    x: u16,
    y: Option<f64>,
}

#[derive(Debug, Rand)]
enum Bar {
     X{x: u8, y: isize},
     Y([bool; 4]),
     Z,
}
```
Now you can call the `Rng::gen()` function on your custom types.

```rust
use rand::Rng;

let mut rng = rand::thread_rng();

println!("{:?}", rng.gen::<Foo>());
println!("{:?}", rng.gen::<Bar>());
```