enum-methods
Enum getter/is_*
method generation.
Please note that this crate is unstable and is subject to change frequently.
I will attempt to prevent seriously breaking changes after we hit 0.1.0.
Links
Usage
In your Cargo.toml
, add this line under your [dependencies]
section:
= "0.0.8"
To use, simply derive and call methods (see the example below).
Why?
Usually when you write an enum with one or zero values, you might want to add a set of getters for them. As such:
But this gets tedious, and adds a lot code for this simple functionality.
Enter enum-methods
.
Instead of doing the above with the if let ... else { panic!(...) }
, you
simply derive from the EnumIntoGetters
extern crate enum_methods;
Requirements and gotchas
Right now, enum-methods
has four derivable options:
EnumAsGetters
for generatingas_*
methods, which return a reference.EnumIntoGetters
for generatinginto_*
methods, which consume the enum and returns the data held by the variant.EnumToGetters
for generatingto_*
methods, which returns a clone of the data held by the variant.EnumIsA
for generatingis_*
methods, which return a boolean indicating whether the enum matches that variant.
EnumAsGetters
, EnumIntoGetters
, and EnumToGetters
have some limitations.
- Any enum variant which has exactly 1 member will have a getter generated for it. All other variants are ignored.
- Enums which derive from
EnumIntoGetters
must also derive fromDebug
- this is for when a method is called for the wrong variant and needs topanic!
.
Furthermore, EnumToGetters
is only for enums whose variants implement
Clone
. There is not yet support for th
EnumIsA
is much simpler than the previous; it simply adds is_*
methods returning a boolean for whether the variant matches or not.
For all generated methods, all names are automatically converted to snake_case.
License
This software is released under the Apache license 2.0. See the LICENSE file for more details.