state

Documentation

Index

• Variables
• func GetDefaultStateDirpath() (string, error)
• func GetDefaultStateFilepath() (string, error)
• func WriteStateFile(path string, state *State) error
• type State
  • func ReadStateFile(path string, dflt *State) (*State, error)
  • func (cfg *State) WriteBack() error

Variables

var DefaultState = State{
	Version: 1,
}

Functions

func GetDefaultStateDirpath

func GetDefaultStateDirpath() (string, error)

func GetDefaultStateFilepath

func GetDefaultStateFilepath() (string, error)

func WriteStateFile

func WriteStateFile(path string, state *State) error

Types

type State

type State struct {
	// to convert across old vs. new version of `type State struct`
	Version int `json:"version"`

	// set for ingestion purpose
	MachineID      *int64                    `json:"machine_id"`
	IngestionToken *typesv1.EnvironmentToken `json:"ingestion_token,omitempty"`

	// update mechanism
	LatestKnownVersion           *semver.Version `json:"latest_known_version,omitempty"`
	LastestKnownVersionUpdatedAt *time.Time      `json:"latest_known_version_updated_at"`

	// prompts
	LastPromptedToSignupAt          *time.Time `json:"last_prompted_to_signup_at"`
	LastPromptedToEnableLocalhostAt *time.Time `json:"last_prompted_to_enable_localhost_at"`

	// preferences set in the CLI/TUI when querying
	CurrentOrgID         *int64 `json:"current_org_id,omitempty"`
	CurrentEnvironmentID *int64 `json:"current_environment_id,omitempty"`
	CurrentMachineID     *int64 `json:"current_machine_id,omitempty"`
	// contains filtered or unexported fields
}

func ReadStateFile

func ReadStateFile(path string, dflt *State) (*State, error)

func (*State) WriteBack

func (cfg *State) WriteBack() error