setup

Documentation

Index

• func DisableJSON()
• func Emit(p Payload)
• func EnableJSON()
• func WaitForProcessToExit(ctx context.Context, pid int)
• type BrothBuildFile
• type BrothBuildInfo
• type BrothPatch
  • func (bp *BrothPatch) FindSubType(subType itchio.BuildFileSubType) *BrothPatchFile
• type BrothPatchFile
• type BrothUpgradePath
• type BuildFolder
• type ErrorHandler
• type FinishHandler
• type InstallSource
• type Installer
  • func NewInstaller(settings InstallerSettings) *Installer
  • func (i *Installer) Install(mv Multiverse)
  • func (i *Installer) Upgrade(mv Multiverse) (*UpgradeResult, error)
  • func (i *Installer) WarmUp()
• type InstallerSettings
• type InstallingUpdate
  • func (p InstallingUpdate) GetType() string
• type Log
  • func (p Log) GetType() string
• type Multiverse
  • func NewMultiverse(params *MultiverseParams) (Multiverse, error)
• type MultiverseParams
• type NoUpdateAvailable
  • func (p NoUpdateAvailable) GetType() string
• type Payload
• type Progress
  • func (p Progress) GetType() string
• type ProgressHandler
• type ProgressLabelHandler
• type ReadyToRelaunch
  • func (p ReadyToRelaunch) GetType() string
• type SourceHandler
• type UpdateFailed
  • func (p UpdateFailed) GetType() string
• type UpdateReady
  • func (p UpdateReady) GetType() string
• type UpgradeResult
• type ValidateHandler

Functions

func DisableJSON

func DisableJSON()

func Emit

func Emit(p Payload)

func EnableJSON

func EnableJSON()

func WaitForProcessToExit

func WaitForProcessToExit(ctx context.Context, pid int)

Types

type BrothBuildFile

type BrothBuildFile struct {
	Type    itchio.BuildFileType    `json:"type"`
	SubType itchio.BuildFileSubType `json:"subType"`
	Size    int64                   `json:"size"`
}

type BrothBuildInfo

type BrothBuildInfo struct {
	Version string            `json:"version"`
	Files   []*BrothBuildFile `json:"files"`
}

type BrothPatch

type BrothPatch struct {
	Version string            `json:"version"`
	Files   []*BrothPatchFile `json:"files"`
}

func (*BrothPatch) FindSubType

func (bp *BrothPatch) FindSubType(subType itchio.BuildFileSubType) *BrothPatchFile

type BrothPatchFile

type BrothPatchFile struct {
	SubType itchio.BuildFileSubType `json:"subType"`
	Size    int64                   `json:"size"`
}

type BrothUpgradePath

type BrothUpgradePath struct {
	Patches []*BrothPatch `json:"patches"`
}

type BuildFolder

type BuildFolder struct {
	Version string
	Path    string
}

type ErrorHandler

type ErrorHandler func(err error)

type FinishHandler

type FinishHandler func(source InstallSource)

type InstallSource

type InstallSource struct {
	Version string
}

type Installer

type Installer struct {
	// contains filtered or unexported fields
}

func NewInstaller

func NewInstaller(settings InstallerSettings) *Installer

func (*Installer) Install

func (i *Installer) Install(mv Multiverse)

func (*Installer) Upgrade

func (i *Installer) Upgrade(mv Multiverse) (*UpgradeResult, error)

func (*Installer) WarmUp

func (i *Installer) WarmUp()

type InstallerSettings

type InstallerSettings struct {
	AppName         string
	Localizer       *localize.Localizer
	OnError         ErrorHandler
	OnProgressLabel ProgressLabelHandler
	OnProgress      ProgressHandler
	OnFinish        FinishHandler
	OnSource        SourceHandler
}

type InstallingUpdate

type InstallingUpdate struct {
	Version string `json:"version"`
}

func (InstallingUpdate) GetType

func (p InstallingUpdate) GetType() string

type Log

type Log struct {
	Level   string `json:"level"`
	Message string `json:"message"`
}

func (Log) GetType

func (p Log) GetType() string

type Multiverse

type Multiverse interface {
	// Called on launch, or when upgrading
	GetCurrentVersion() *BuildFolder

	// Called when we start patching
	MakeStagingFolder() (string, error)
	// defer'd at the end of patching
	CleanStagingFolder() error

	// Record a freshly-patched build as ready
	QueueReady(build *BuildFolder) error

	// Returns true if we have a ready build pending
	HasReadyPending() bool

	// Returns true if the ready pending version is 'version'
	ReadyPendingIs(version string) bool

	// Make the ready build current.
	MakeReadyCurrent() error

	// Validates the current build (can be used after heal)
	ValidateCurrent() error

	// Returns a human-friendly representation of the state of this multiverse
	String() string
}

func NewMultiverse

func NewMultiverse(params *MultiverseParams) (Multiverse, error)

type MultiverseParams

type MultiverseParams struct {
	// `itch`, `kitch`
	AppName string

	// on Linux, `~/.itch`
	// on Windows, `%LOCALAPPDATA%/itch`
	// on macOS, `~/Library/Application Support/itch-setup`
	BaseDir string

	// If non-empty, this is where we'll store current
	// on macOS, this is `~/Applications`
	ApplicationsDir string

	// This is called with a folder before making it the current version
	OnValidate ValidateHandler
}

type NoUpdateAvailable

type NoUpdateAvailable struct{}

func (NoUpdateAvailable) GetType

func (p NoUpdateAvailable) GetType() string

type Payload

type Payload interface {
	GetType() string
}

type Progress

type Progress struct {
	Progress float64 `json:"progress"`
	BPS      float64 `json:"bps"`
	ETA      float64 `json:"eta"`
}

func (Progress) GetType

func (p Progress) GetType() string

type ProgressHandler

type ProgressHandler func(progress float64)

type ProgressLabelHandler

type ProgressLabelHandler func(label string)

type ReadyToRelaunch

type ReadyToRelaunch struct{}

func (ReadyToRelaunch) GetType

func (p ReadyToRelaunch) GetType() string

type SourceHandler

type SourceHandler func(source InstallSource)

type UpdateFailed

type UpdateFailed struct {
	Message string `json:"message"`
}

func (UpdateFailed) GetType

func (p UpdateFailed) GetType() string

type UpdateReady

type UpdateReady struct {
	Version string `json:"version"`
}

func (UpdateReady) GetType

func (p UpdateReady) GetType() string

type UpgradeResult

type UpgradeResult struct {
	DidUpgrade bool
}

type ValidateHandler

type ValidateHandler func(dir string) error