side

Documentation

Index

• Variables
• type Enum
  • func Extract(str string) Enum
  • func (e Enum) EnsureValid() Enum
  • func (e Enum) Horizontal() bool
  • 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
  • func (e Enum) Vertical() bool

Variables

var All = []Enum{
	Top,
	Left,
	Bottom,
	Right,
}

All possible values.

Types

type Enum

type Enum byte

Enum specifies which side an object should be on.

const (
	Top Enum = iota
	Left
	Bottom
	Right
)

Possible values.

func Extract

func Extract(str string) Enum

Extract the value from a string.

func (Enum) EnsureValid

func (e Enum) EnsureValid() Enum

EnsureValid ensures this is of a known value.

func (Enum) Horizontal

func (e Enum) Horizontal() bool

Horizontal returns true if the side is to the left or right.

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.

func (Enum) Vertical

func (e Enum) Vertical() bool

Vertical returns true if the side is to the top or bottom.