enum_stringify 0.6.4

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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89

# enum-stringify

[![Crates.io](https://img.shields.io/crates/v/enum-stringify.svg)](https://crates.io/crates/enum-stringify)
[![docs.rs](https://img.shields.io/badge/docs.rs-enum--stringify-blue)](https://docs.rs/enum-stringify)
![License](https://img.shields.io/crates/l/enum-stringify)

A procedural macro crate to generate string representations of Rust enums.  
Derive `EnumStringify` to automatically implement `Display`, `TryFrom<&str>`, `TryFrom<String>`, and `FromStr` for your enum, using the variant name as the string representation.

---

## Features

- **Automatic string conversion:** Implements `Display`, `FromStr`, and `TryFrom` for enums.
- **Customizable output:** Add prefixes, suffixes, and change the case of the string representation.
- **Ergonomic usage:** Simple derive macro with useful defaults.

---

## Usage

```rust
use enum_stringify::EnumStringify;
use std::convert::TryFrom;
use std::str::FromStr;

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

fn main() {
    // Display
    println!("{}", MyEnum::Variant1); // Prints "Variant1"

    // To string
    assert_eq!(MyEnum::Variant1.to_string(), "Variant1");

    // TryFrom<&str>
    assert_eq!(MyEnum::try_from("Variant2").unwrap(), MyEnum::Variant2);

    // TryFrom<String>
    assert_eq!(MyEnum::try_from("Variant3".to_string()).unwrap(), MyEnum::Variant3);

    // FromStr
    assert_eq!(MyEnum::from_str("Variant1").unwrap(), MyEnum::Variant1);
}
```

---

## Custom String Representation

You can customize the string representation using attributes for prefix, suffix, and case.

```rust
use enum_stringify::EnumStringify;

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

In this example, the string representation of `MyEnum::Variant1` will be `MyPrefixVARIANT1MySuffix`.

### Supported options

- **prefix:** String prepended to each variant
- **suffix:** String appended to each variant
- **case:** Changes the case (`"upper_flat"`, `"lower_flat"`, etc.)

---

## Documentation

- [API Documentation on docs.rs](https://docs.rs/enum-stringify)
- [Crate on crates.io](https://crates.io/crates/enum-stringify)

---

## License

This project is licensed under the MIT License. See [LICENSE](LICENSE) for details.