state

Documentation

Index

• Constants
• func Init(config *config.Config) error
• func Write(config *config.Config, state *State) error
• type Backup
• type Context
• type Group
• type History
  • func ComputeHistory(config *config.Config, entry History, history []History) []History
• type Revision
• type State
  • func Read(config *config.Config) (*State, error)

Constants

const DefaultMaximumHistorySize = 10

Functions

func Init

func Init(config *config.Config) error

Init checks if the state directory exists and creates all directories and files if necessary

func Write

func Write(config *config.Config, state *State) error

Write serializes the current state with koanf

Types

type Backup

type Backup struct {
	Revisions []Revision `json:"revisions,omitempty"`
}

type Context

type Context struct {
	Active  string    `json:"active,omitempty"`
	History []History `json:"history,omitempty"`
}

type Group

type Group struct {
	Active  string    `json:"active,omitempty"`
	History []History `json:"history,omitempty"`
}

type History

type History string

func ComputeHistory

func ComputeHistory(config *config.Config, entry History, history []History) []History

ComputeHistory takes the current history and appends a new entry If the history size is larger than the configured or default size, it will remove the oldest entry from the history

type Revision

type Revision string

type State

type State struct {
	Group   Group   `json:"group"`
	Context Context `json:"context"`
	Backup  Backup  `json:"backup"`
}

func Read

func Read(config *config.Config) (*State, error)

Read reads the current state file and serialize it with koanf