enumer/README.md

53 lines
1.7 KiB
Markdown
Raw Normal View History

2015-12-29 16:29:35 +03:00
#Enumer
2015-12-29 16:27:33 +03:00
Enumer generates Go code to get string names from enum values and viceversa.
It is a fork of [Rob Pikes Stringer tool](https://godoc.org/golang.org/x/tools/cmd/stringer)
but adding a *"string to enum value"* method to the generated code.
2015-12-31 17:36:39 +03:00
This is useful when you need to read enum values from the command line arguments, from a configuration file,
from a REST API request... In short, from those places where using the real enum value (an integer) would
be almost meaningless or hard to trace or use by a human
For example, if we have an enum type called `Pill`,
```
type Pill int
2015-12-29 16:27:33 +03:00
2015-12-31 17:36:39 +03:00
const (
Placebo Pill = iota
Aspirin
Ibuprofen
Paracetamol
Acetaminophen = Paracetamol
)
```
executing `enumer -type=Pill` will generate a new file with two methods:
2015-12-29 16:27:33 +03:00
```
func (i Pill) String() string {
//...
}
func PillString(s string) (Pill, error) {
//...
}
```
2015-12-31 17:36:39 +03:00
From now on, we can:
```
// Convert any Pill value to string
var aspirinString string = Aspirin.String()
// (or use it in any place where a Stringer is accepted)
fmt.Println("I need ", Paracetamol) // Will print "I need Paracetamol"
// Convert a string with the enum name to the corresponding enum value
pill, err := PillString("Ibuprofen")
if err != nil {
fmt.Println("Unrecognized pill: ", err)
return
}
// Now pill == Ibuprofen
```
The generated code is exactly the same as the Stringer tool plus the `<Type>String` method, so you can use
**Enumer** where you are already using **Stringer** without any code change.
2015-12-29 16:27:33 +03:00
2015-12-31 17:36:39 +03:00
## How to use
The usage of Enumer is the same as Stringer, no changes were introduced.
For more information please refer to the [Stringer docs](https://godoc.org/golang.org/x/tools/cmd/stringer)