behavior

Documentation

Index

• Variables
• type Enum
  • func Extract(str string) 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{
	Unmodified,
	Fill,
	Follow,
	HintedFill,
}

All possible values.

Types

type Enum

type Enum byte

Enum controls how auto-sizing of the scroll content's preferred size is handled.

const (
	Unmodified Enum = iota
	Fill            // If the content is smaller than the available space, expand it
	Follow          // Fix the content to the view size
	HintedFill      // Uses hints to try and fix the content to the view size, but if the resulting content is smaller than the available space, expands it
)

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) 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.