Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Printable enums in Go

Tags:

string

enums

go

In some cases, it's convenient for user interaction and debugging purposes to have a human-readable string representation of enums. So far, the best I have come up with is:

type ElementType int

const (
    Fire = ElementType(iota)
    Air
    Water
    Earth
)

var elementTypeMap = map[ElementType]string{
    Fire: "The Fiery Fire",
    Air: "The Airy Air",
    Water: "The Watery Water",
    Earth: "The Earthy Earth",
}

func (el ElementType) String() string {
    return elementTypeMap[el]
}

The above, allows me to use and pass the enum as an int, keeping its standard performance, and to easily print its string representation anywhere. The only drawback is that there is an amount of boilerplate code that adds up if you have many enum types: I would be rather happy to avoid it.

Is there a way, preferably an idiomatic one, to reduce the boilerplate code above?

like image 268
Francesco Avatar asked Sep 13 '25 11:09

Francesco


1 Answers

This looks dryer (and faster) :

type ElementType int

const (
    Fire = ElementType(iota)
    Air
    Water
    Earth
)

var elementnames = [...]string {
    "The Fiery Fire",
    "The Airy Air",
    "The Watery Water",
    "The Earthy Earth"
}

func (el ElementType) String() string {
    return elementnames[el]
}

Note that there was a discussion on golang-nuts on whether giving a generic solution to assign names to enum constants and as far as I know it wasn't seen as necessary (see https://groups.google.com/forum/#!topic/golang-nuts/fCdBSRNNUY8).

like image 89
Denys Séguret Avatar answered Sep 16 '25 01:09

Denys Séguret