statefile

Documentation

Index

• Constants
• type LegacyState
• type State
  • func LoadState() (State, error)
  • func (s *State) IsValid() bool
  • func (s *State) MigrateFrom(prev interface{}) migrate.Migrateable
  • func (s *State) Save() error

Constants

const StateStructVersion = 20220411

Types

type LegacyState

type LegacyState struct {
	LastCheck      string `json:"lastChecked"`    // an RFC3339 encoded time stamp
	InstallationID string `json:"installationId"` // a UUIDv4 string
}

LegacyState is a struct used to migrate the State to serialize with snake case property names(migrated in v0.14.0)

type State

type State struct {
	LastCheck      string `json:"last_checked"`    // an RFC3339 encoded time stamp
	InstallationID string `json:"installation_id"` // a UUIDv4 string
	StructVersion  int64  `json:"struct_version"`
}

State is a struct containing installation state

func LoadState

func LoadState() (State, error)

func (*State) IsValid

func (s *State) IsValid() bool

IsValid checks whether the struct was correctly deserialized, by checking if the StructVersion is populated

func (*State) MigrateFrom

func (s *State) MigrateFrom(prev interface{}) migrate.Migrateable

func (*State) Save

func (s *State) Save() error

Save the state NOTE: this updates the last checked time