Documentation
¶
Index ¶
Constants ¶
const ( ActionEnumCreate _ActionEnum = "create" ActionEnumVersion _ActionEnum = "version" ActionEnumHelp _ActionEnum = "help" )
const ( InitialismEnumACL _InitialismEnum = "ACL" InitialismEnumAPI _InitialismEnum = "API" InitialismEnumASCII _InitialismEnum = "ASCII" InitialismEnumCPU _InitialismEnum = "CPU" // InitialismEnumCSS Cascading style sheets. InitialismEnumCSS _InitialismEnum = "CSS" // InitialismEnumEOF eof is End of File. InitialismEnumEOF _InitialismEnum = "EOF" InitialismEnumGPU _InitialismEnum = "GPU" InitialismEnumGUID _InitialismEnum = "GUID" // InitialismEnumHTML HyperTextMarkupLanguage. InitialismEnumHTML _InitialismEnum = "HTML" InitialismEnumHTTP _InitialismEnum = "HTTP" InitialismEnumHTTPS _InitialismEnum = "HTTPS" InitialismEnumID _InitialismEnum = "ID" InitialismEnumIP _InitialismEnum = "IP" InitialismEnumJSON _InitialismEnum = "JSON" InitialismEnumJWT _InitialismEnum = "JWT" InitialismEnumRAM _InitialismEnum = "RAM" InitialismEnumREST _InitialismEnum = "REST" InitialismEnumSQL _InitialismEnum = "SQL" InitialismEnumTCP _InitialismEnum = "TCP" InitialismEnumTLS _InitialismEnum = "TLS" InitialismEnumUDP _InitialismEnum = "UDP" InitialismEnumURI _InitialismEnum = "URI" InitialismEnumURL _InitialismEnum = "URL" InitialismEnumUTF _InitialismEnum = "UTF" InitialismEnumUUID _InitialismEnum = "UUID" InitialismEnumXML _InitialismEnum = "XML" InitialismEnumYAML _InitialismEnum = "YAML" InitialismEnumZIP _InitialismEnum = "ZIP" )
Variables ¶
This section is empty.
Functions ¶
func ActionEnumStrings ¶
func ActionEnumStrings() []string
ActionEnumStrings 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 ActionEnumValues.
func FormatInitialism ¶
func InitialismEnumStrings ¶
func InitialismEnumStrings() []string
InitialismEnumStrings 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 InitialismEnumValues.
Types ¶
type ActionEnum ¶
type ActionEnum interface {
fmt.Stringer
encoding.TextMarshaler
// contains filtered or unexported methods
}
ActionEnum 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 ActionEnumValues ¶
func ActionEnumValues() []ActionEnum
ActionEnumValues returns a slice of values of the ActionEnum enum. Each enum value matches the index of ActionEnumStrings.
func ToActionEnum ¶
func ToActionEnum(s string) (ActionEnum, error)
ToActionEnum 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 ActionEnumUnmarshaler ¶
type ActionEnumUnmarshaler string
func (ActionEnumUnmarshaler) Extract ¶
func (x ActionEnumUnmarshaler) Extract() ActionEnum
func (*ActionEnumUnmarshaler) UnmarshalText ¶
func (x *ActionEnumUnmarshaler) UnmarshalText(text []byte) error
type InitialismEnum ¶
type InitialismEnum interface {
fmt.Stringer
encoding.TextMarshaler
// contains filtered or unexported methods
}
InitialismEnum 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 InitialismEnumValues ¶
func InitialismEnumValues() []InitialismEnum
InitialismEnumValues returns a slice of values of the InitialismEnum enum. Each enum value matches the index of InitialismEnumStrings.
func ToInitialismEnum ¶
func ToInitialismEnum(s string) (InitialismEnum, error)
ToInitialismEnum 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 InitialismEnumUnmarshaler ¶
type InitialismEnumUnmarshaler string
func (InitialismEnumUnmarshaler) Extract ¶
func (x InitialismEnumUnmarshaler) Extract() InitialismEnum
func (*InitialismEnumUnmarshaler) UnmarshalText ¶
func (x *InitialismEnumUnmarshaler) UnmarshalText(text []byte) error
type InvalidActionEnumError ¶
type InvalidActionEnumError struct {
// contains filtered or unexported fields
}
InvalidActionEnumError is returned by ToActionEnum if the passed in string isn't one of the enum values.
func (InvalidActionEnumError) Error ¶
func (e InvalidActionEnumError) Error() string
Error exposes the invalid string used and shows all the possible values.
func (InvalidActionEnumError) Is ¶
func (e InvalidActionEnumError) Is(err error) bool
Is tells you if target can be unwrapped to be an InvalidActionEnumError.
type InvalidInitialismEnumError ¶
type InvalidInitialismEnumError struct {
// contains filtered or unexported fields
}
InvalidInitialismEnumError is returned by ToInitialismEnum if the passed in string isn't one of the enum values.
func (InvalidInitialismEnumError) Error ¶
func (e InvalidInitialismEnumError) Error() string
Error exposes the invalid string used and shows all the possible values.
func (InvalidInitialismEnumError) Is ¶
func (e InvalidInitialismEnumError) Is(err error) bool
Is tells you if target can be unwrapped to be an InvalidInitialismEnumError.
Source Files