check

Documentation

Index

• Variables
• type Enum
  • func Extract(str string) Enum
  • func FromBool(b bool) Enum
  • func (e Enum) EnsureValid() Enum
  • func (e Enum) Key() string
  • func (e Enum) MarshalText() (text []byte, err error)
  • func (e Enum) String() string
  • func (e *Enum) UnmarshalText(text []byte) error

Variables

var All = []Enum{
	Off,
	On,
	Mixed,
}

All possible values.

Types

type Enum

type Enum byte

Enum represents the current state of something like a check box or mark.

const (
	Off Enum = iota
	On
	Mixed
)

Possible values.

func Extract

func Extract(str string) Enum

Extract the value from a string.

func FromBool

func FromBool(b bool) Enum

FromBool returns the equivalent Enum.

func (Enum) EnsureValid

func (e Enum) EnsureValid() Enum

EnsureValid ensures this is of a known value.

func (Enum) Key

func (e Enum) Key() string

Key returns the key used in serialization.

func (Enum) MarshalText

func (e Enum) MarshalText() (text []byte, err error)

MarshalText implements the encoding.TextMarshaler interface.

func (Enum) String

func (e Enum) String() string

String implements fmt.Stringer.

func (*Enum) UnmarshalText

func (e *Enum) UnmarshalText(text []byte) error

UnmarshalText implements the encoding.TextUnmarshaler interface.