state

Documentation

Index

• type Binary
  • func (bs *Binary) Add(pm *bootstrapper.PackageManifest)
• type State
  • func Load() (State, error)
  • func (s *State) CleanPackages() error
  • func (s *State) CleanVersions() error
  • func (s *State) Packages() (pkgs []string)
  • func (s *State) Save() error
  • func (s *State) Versions() (vers []string)

Types

type Binary

type Binary struct {
	DxvkVersion string
	Version     string
	Packages    []string
}

BinaryState is used track a Binary's deployment and wineprefix.

func (*Binary) Add

func (bs *Binary) Add(pm *bootstrapper.PackageManifest)

Add formats the given package manifest into a Binary form.

type State

type State struct {
	Player Binary
	Studio Binary
}

State holds various details about Vinegar's current state.

func Load

func Load() (State, error)

Load returns the state file's contents in State form.

If the state file does not exist or is empty, an empty state is returned.

func (*State) CleanPackages

func (s *State) CleanPackages() error

CleanPackages removes all cached package downloads in dirs.Downloads that aren't held in the state's Binary packages.

func (*State) CleanVersions

func (s *State) CleanVersions() error

CleanPackages removes all Binary versions that aren't held in the state's Binary packages.

func (*State) Packages

func (s *State) Packages() (pkgs []string)

Packages returns all the available Binary packages from the state.

func (*State) Save

func (s *State) Save() error

Save saves the current state to the state file.

func (*State) Versions

func (s *State) Versions() (vers []string)

Packages returns all the available Binary versions from the state.