-
-
Save CarterTsai/e3b51f09debe4cea4a7c9bd11af7ac8e to your computer and use it in GitHub Desktop.
Golang Enum pattern that can be serialized to json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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