Documentation
¶
Index ¶
Constants ¶
const ( DirectionEnumN _DirectionEnum = "North" DirectionEnumS _DirectionEnum = "South" DirectionEnumE _DirectionEnum = "East" DirectionEnumW _DirectionEnum = "West" )
Variables ¶
This section is empty.
Functions ¶
func DirectionEnumStrings ¶
func DirectionEnumStrings() []string
DirectionEnumStrings returns a slice of all enum values as strings. This could be useful for validation with something like slices.Contains or quickly seeing all values of an enum. Each string matches the index of DirectionEnumValues.
Types ¶
type DirectionEnum ¶
type DirectionEnum interface {
fmt.Stringer
encoding.TextMarshaler
// contains filtered or unexported methods
}
DirectionEnum is a true enum, i.e. using this as a parameter in a function declaration requires the use of one of the constants defined in this package.
func DirectionEnumValues ¶
func DirectionEnumValues() []DirectionEnum
DirectionEnumValues returns a slice of values of the DirectionEnum enum. Each enum value matches the index of DirectionEnumStrings.
func ToDirectionEnum ¶
func ToDirectionEnum(s string) (DirectionEnum, error)
ToDirectionEnum retrieves an enum value from the constants defined in this package. It tries it's best to find s in the enum by using the original-case, uppercase and lowercase.
type DirectionEnumUnmarshaler ¶
type DirectionEnumUnmarshaler string
func (DirectionEnumUnmarshaler) Extract ¶
func (x DirectionEnumUnmarshaler) Extract() DirectionEnum
func (*DirectionEnumUnmarshaler) UnmarshalText ¶
func (x *DirectionEnumUnmarshaler) UnmarshalText(text []byte) error
type InvalidDirectionEnumError ¶
type InvalidDirectionEnumError struct {
// contains filtered or unexported fields
}
InvalidDirectionEnumError is returned by ToDirectionEnum if the passed in string isn't one of the enum values.
func (InvalidDirectionEnumError) Error ¶
func (e InvalidDirectionEnumError) Error() string
Error exposes the invalid string used and shows all the possible values.
func (InvalidDirectionEnumError) Is ¶
func (e InvalidDirectionEnumError) Is(err error) bool
Is tells you if target can be unwrapped to be an InvalidDirectionEnumError.
Source Files