custom_attrs 1.2.4

A library that allows you to configure values specific to each variants of an enum.
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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109

# Custom Attrs


[![Build](https://github.com/NovaliX-Dev/custom_attrs/actions/workflows/build.yml/badge.svg)](https://github.com/NovaliX-Dev/custom_attrs/actions/workflows/build.yml)
[![Tests](https://github.com/NovaliX-Dev/custom_attrs/actions/workflows/tests.yml/badge.svg)](https://github.com/NovaliX-Dev/custom_attrs/actions/workflows/tests.yml)
[![Crates.io](https://img.shields.io/crates/v/custom_attrs.svg)](https://crates.io/crates/custom_attrs)
[![License](https://img.shields.io/crates/l/custom_attrs.svg)](./LICENSE)
[![Documentation](https://docs.rs/custom_attrs/badge.svg)](https://docs.rs/custom_attrs)

A library that allows you to configure values specific to each variants of an enum.

## Installation and Usage


Add this to your `Cargo.toml` file :
```toml
[dependencies]
custom_attrs = "1.2.2"
```

### Attribute declaration.


By default, an attribute declaration is composed of two parts : the attribute's name and it's type.

```rust
#[attr(name: u32)]

```

Optionally, you can add more components.

### Optional components


You can set the visibility of the attribute. This will change the visibility of the getter function.

```rust
#[attr(pub name: u32)]

enum Enum {}
```

By default, each attribute declared require a value to be set for each variant.
If this requirement is not set, this library will produce an error.

You can disable this behavior by making it optional, by writing the type into an `Option`, or by adding a default value behind the attribute declaration. See the example below.

```rust
#[attr(name: Option<u32>)]

enum Enum {}
```

```rust
#[attr(name: u32 = 3)]

enum Enum {}
```

### Setting a value


To set a value for a variant, just add the name of the attribute followed by the value you want to assign it.


```rust
enum Enum {
    #[attr(name = 4)]
    VariantA
}
```

If the attribute is optional, you don't have to wrap you value into a `Some`. `custom_attrs` will do it for you. If you want the value to be `None`, just put `None` behind the value.

```rust
enum Enum {
    #[attr(name = 4)]
    VariantA,

    #[attr(name = None)]
    VariantA,
}
```

## Examples


```Rust
use custom_attrs::CustomAttrs;

// ...

#[derive(CustomAttrs)]


// set the attributes
#[attr(pub a: usize)]

#[attr(b: Option<usize>)] // attributes can be optional

#[attr(c: &'static str = "Hello world!")] // and can also have default values

enum Enum {
    #[attr(a = 5)]
    #[attr(b = 3)]
    Variant1,

    #[attr(a = 3)]
    #[attr(c = "Hello again !")]
    Variant2,
}

fn main() {
    let a = Enum::Variant1.get_a();
}
```

See the examples directory for more details.

# License


Licensed under the MIT license.