Skip to content

Instantly share code, notes, and snippets.

@syntaqx
Forked from lummie/enum.go
Created September 29, 2020 01:36
Show Gist options
  • Save syntaqx/9a73044aa1fa70236d6bc9d7d7ab5a63 to your computer and use it in GitHub Desktop.
Save syntaqx/9a73044aa1fa70236d6bc9d7d7ab5a63 to your computer and use it in GitHub Desktop.
Golang Enum pattern that can be serialized to json
package enum_example
import (
"bytes"
"encoding/json"
)
// TaskState represents the state of task, moving through Created, Running then Finished or Errorred
type TaskState int
const (
// Created represents the task has been created but not started yet
Created TaskState = iota
//Running represents the task has started
Running
// Finished represents the task is complete
Finished
// Errorred represents the task has encountered a problem and is no longer running
Errorred
)
func (s TaskState) String() string {
return toString[s]
}
var toString = map[TaskState]string{
Created: "Created",
Running: "Running",
Finished: "Finished",
Errorred: "Errorred",
}
var toID = map[string]TaskState{
"Created": Created,
"Running": Running,
"Finished": Finished,
"Errorred": Errorred,
}
// MarshalJSON marshals the enum as a quoted json string
func (s TaskState) MarshalJSON() ([]byte, error) {
buffer := bytes.NewBufferString(`"`)
buffer.WriteString(toString[s])
buffer.WriteString(`"`)
return buffer.Bytes(), nil
}
// UnmarshalJSON unmashals a quoted json string to the enum value
func (s *TaskState) UnmarshalJSON(b []byte) error {
var j string
err := json.Unmarshal(b, &j)
if err != nil {
return err
}
// Note that if the string cannot be found then it will be set to the zero value, 'Created' in this case.
*s = toID[j]
return nil
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment