internal

Documentation

Index

• type Context
  • func NewContext(dir *string) (*Context, error)
  • func (ctx *Context) Execute(tx ccmodupdater.PackageTX, stats *Stats) error
  • func (ctx *Context) Game() *ccmodupdater.GameInstance
  • func (ctx *Context) Upgrade() (*OnlineContext, error)
• type OnlineContext
  • func NewOnlineContext(dir *string) (*OnlineContext, error)
  • func (rwc *OnlineContext) RemotePackages() map[string]ccmodupdater.RemotePackage
• type Stats
  • func (stats *Stats) AddWarning(warning string)

Types

type Context

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

Context contains the context details for this command.

func NewContext

func NewContext(dir *string) (*Context, error)

NewContext creates a new local context.

func (*Context) Execute

func (ctx *Context) Execute(tx ccmodupdater.PackageTX, stats *Stats) error

Execute executes a package transaction.

func (*Context) Game

func (ctx *Context) Game() *ccmodupdater.GameInstance

func (*Context) Upgrade

func (ctx *Context) Upgrade() (*OnlineContext, error)

Upgrade upgrades the Context to an OnlineContext.

type OnlineContext

type OnlineContext struct {
	Context
	// contains filtered or unexported fields
}

OnlineContext contains the details for an online context.

func NewOnlineContext

func NewOnlineContext(dir *string) (*OnlineContext, error)

NewOnlineContext creates a new online context.

func (*OnlineContext) RemotePackages

func (rwc *OnlineContext) RemotePackages() map[string]ccmodupdater.RemotePackage

RemotePackages returns all the remote packages.

type Stats

type Stats struct {
	Installed int `json:"installed"`
	Updated   int `json:"updated"`
	Removed   int `json:"removed"`

	Warnings []string `json:"warnings,omitempty"`
}

Stats contains the statistics about the installed mods

func (*Stats) AddWarning

func (stats *Stats) AddWarning(warning string)

AddWarning to the statistics