enum-values 0.1.0

Exposes enum values via reflection
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
48

# enum-values

[![CI](https://gitlab.com/wiktor/enum-values/badges/main/pipeline.svg)](https://gitlab.com/wiktor/enum-values/badges/main/pipeline.svg)
[![Crates.io](https://img.shields.io/crates/v/enum-values)](https://crates.io/crates/enum-values)

`EnumValues` works with a specific subset of enums: these that have primitive discriminants.
The guiding use case was automatic generation of exit codes documentation from `Error` enums.

```rust
use enum_values::EnumValues;

/// Mapping for relevant [`Error`] variants to an [`std::process::ExitCode`].
#[derive(EnumValues, Debug)]
#[repr(u8)]
pub enum Error {
    /// IO error.
    Io(std::io::Error) = 2,

    /// Fmt error.
    Fmt(std::fmt::Error) = 3,
}

let variants = Error::variants().collect::<Vec<_>>();
eprintln!("Variants: {variants:#?}",);
assert_eq!(variants.len(), 2);

assert_eq!("IO error.", variants[0].doc);
assert_eq!("Io", variants[0].name);
assert_eq!(2, variants[0].value);

assert_eq!("Fmt error.", variants[1].doc);
assert_eq!("Fmt", variants[1].name);
assert_eq!(3, variants[1].value);
```

## License

This project is licensed under either of:

  - [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0),
  - [MIT license](https://opensource.org/licenses/MIT).

at your option.

### Contribution

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.