state

Documentation

Overview

Package state is in charge of storing and reading application state.

Index

• Constants
• func IsInitialized() bool
• type Application
  • func Create(appContext context.Context, appConfig application.Configuration, lg iLogger) *Application
  • func Get() *Application
  • func (as *Application) Persist() error
  • func (as *Application) PrintConfig()
• type Once

Constants

const (
	// ViewHostList mode is active when we browse through a list of hostnames.
	ViewHostList view = iota
	// ViewGroupList mode is active when the app displays available host groups.
	ViewGroupList
	// ViewEditItem mode is active when we edit existing or add a new host.
	ViewEditItem
	// ViewMessage mode is active when there was an error when attempted to connect to a remote host.
	ViewMessage
)

Functions

func IsInitialized

func IsInitialized() bool

IsInitialized - checks if the application state is initialized.

Types

type Application

type Application struct {
	Selected int `yaml:"selected"`

	Logger       iLogger               `yaml:"-"`
	CurrentView  view                  `yaml:"-"`
	Width        int                   `yaml:"-"`
	Height       int                   `yaml:"-"`
	ScreenLayout constant.ScreenLayout `yaml:"screenLayout,omitempty"`
	Group        string                `yaml:"group,omitempty"`
	// SSHConfigEnabled is a part of ApplicationState, not user config, because it is a feature flag
	// which is persisted across application restarts. In other words, once defined, it will be
	// persisted in the state.yaml file and will be used in the next application run.
	SSHConfigEnabled  bool                      `yaml:"enable_ssh_config"`
	ApplicationConfig application.Configuration `yaml:"-"`
	Context           context.Context           `yaml:"-"`
	// contains filtered or unexported fields
}

Application stores application state.

func Create

func Create(appContext context.Context,
	appConfig application.Configuration,
	lg iLogger,
) *Application

Create - creates application state.

func Get

func Get() *Application

Get - returns application state.

func (*Application) Persist

func (as *Application) Persist() error

Persist saves app state to disk.

func (*Application) PrintConfig

func (as *Application) PrintConfig()

PrintConfig outputs user-definable parameters in the console.

type Once

type Once interface {
	Do(func())
}

Once - this interface is used to avoid sync.Once restrictions in unit-tests.