enum_stringify 0.6.1

Macro to generate string conversion functions for enums
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
49
50
51
52

# enum-stringify

Set of macros (only one for now) to generate a string representation of an enum. When using
`#[derive(EnumStringify)]` on an enum, it will implement `std::fmt::Display`, `TryFrom<&str>`,
`TryFrom<String>` and `std::str::FromStr` for it. It will use the name of the enum variant as the
string representation.

## Usage

```rust
use enum_stringify::EnumStringify;

#[derive(EnumStringify)]
enum MyEnum {
    Variant1,
    Variant2,
    Variant3,
}

fn main() {
    println!("{}", MyEnum::Variant1); // Prints "Variant1"
    assert_eq!(MyEnum::Variant1.to_string(), "Variant1");
    assert_eq!(MyEnum::try_from("Variant2").unwrap(), MyEnum::Variant2);
    assert_eq!(MyEnum::try_from("Variant3".to_string()).unwrap(), MyEnum::Variant3);
    assert_eq!(MyEnum::from_str("Variant1").unwrap(), MyEnum::Variant1);
}
```

### Custom string representation

You can customize the string representation of the enum by adding prefixes or/and suffixes to the
variants and also changing the case of the string representation.

```rust
use enum_stringify::EnumStringify;

#[derive(EnumStringify)]
#[enum_stringify(prefix = "MyPrefix", suffix = "MySuffix", case = "upper_flat")]
enum MyEnum {
    Variant1,
    Variant2,
    Variant3,
}
```

In this case the string representation of `MyEnum::Variant1` will be `MyPrefixVariant1MySuffix`(and
so on for the other variants).

## Documentation and installation

See [docs.rs](https://docs.rs/enum-stringify) for documentation.
It is available on [crates.io](https://crates.io/crates/enum-stringify) as well.