operate

package
v11.1.0+incompatible Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 16, 2018 License: MIT Imports: 37 Imported by: 11

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var ErrAborted = errors.New("operation was aborted")

ErrAborted is returned when the user stopped an operation outside the client's control and it should just be stopped.

View Source 
var ErrCancelled = errors.New("operation was cancelled")

ErrCancelled is returned when the client asked for an operation to be cancelled

Functions

func CheckUpdate 

func CheckUpdate(params *buse.CheckUpdateParams, consumer *state.Consumer, harness harness.Harness, ctx context.Context, conn Conn) (*buse.CheckUpdateResult, error)

func CleanDownloadsApply 

func CleanDownloadsApply(params *buse.CleanDownloadsApplyParams, consumer *state.Consumer) (*buse.CleanDownloadsApplyResult, error)

func CleanDownloadsSearch 

func CleanDownloadsSearch(params *buse.CleanDownloadsSearchParams, consumer *state.Consumer) (*buse.CleanDownloadsSearchResult, error)

func ClientFromCredentials 

func ClientFromCredentials(credentials *buse.GameCredentials) (*itchio.Client, error)

func DownloadInstallSource 

func DownloadInstallSource(consumer *state.Consumer, stageFolder string, ctx context.Context, file eos.File, destPath string) error

func GameFindUploads 

func GameFindUploads(ctx *mansion.Context, conn *jsonrpc2.Conn, req *jsonrpc2.Request) (*buse.GameFindUploadsResult, error)

func GameToString 

func GameToString(game *itchio.Game) string

func Install 

func Install(oc *OperationContext, meta *MetaSubcontext) (*installer.InstallResult, error)

func LogUpload 

func LogUpload(consumer *state.Consumer, u *itchio.Upload, b *itchio.Build)

func MakeItchfsURL 

func MakeItchfsURL(params *ItchfsURLParams) string

func NewStateConsumer 

func NewStateConsumer(params *NewStateConsumerParams) (*state.Consumer, error)

func Start 

func Start(ctx context.Context, conn Conn, params *buse.OperationStartParams) (err error)

Types

type CommitInstallParams 

type CommitInstallParams struct {
	InstallerName string
	InstallFolder string

	Game   *itchio.Game
	Upload *itchio.Upload
	Build  *itchio.Build

	InstallResult *installer.InstallResult
}

type Conn 

type Conn interface {
	Notify(ctx context.Context, method string, params interface{}) error
	Call(ctx context.Context, method string, params interface{}, result interface{}) error
}

type InstallSubcontext 

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

func (*InstallSubcontext) Data 

func (mt *InstallSubcontext) Data() interface{}

func (*InstallSubcontext) Key 

func (mt *InstallSubcontext) Key() string

type InstallSubcontextState 

type InstallSubcontextState struct {
	DownloadSessionId   string                   `json:"downloadSessionId,omitempty"`
	InstallerInfo       *installer.InstallerInfo `json:"installerInfo,omitempty"`
	IsAvailableLocally  bool                     `json:"isAvailableLocally,omitempty"`
	FirstInstallResult  *installer.InstallResult `json:"firstInstallResult,omitempty"`
	SecondInstallerInfo *installer.InstallerInfo `json:"secondInstallerInfo,omitempty"`
}

type ItchfsURLParams 

type ItchfsURLParams struct {
	Credentials *buse.GameCredentials
	UploadID    int64
	BuildID     int64
	FileType    string
	UUID        string
}

type MetaSubcontext 

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

func (*MetaSubcontext) Data 

func (mt *MetaSubcontext) Data() interface{}

func (*MetaSubcontext) Key 

func (mt *MetaSubcontext) Key() string

type NewStateConsumerParams 

type NewStateConsumerParams struct {
	// Mandatory
	Conn Conn
	Ctx  context.Context

	// Optional
	LogFile *os.File
}

type OperationContext 

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

func LoadContext 

func LoadContext(conn Conn, ctx context.Context, parentConsumer *state.Consumer, stageFolder string) (*OperationContext, error)

func (*OperationContext) Consumer 

func (oc *OperationContext) Consumer() *state.Consumer

func (*OperationContext) EndProgress 

func (oc *OperationContext) EndProgress()

func (*OperationContext) Load 

func (oc *OperationContext) Load(s Subcontext)

func (*OperationContext) Retire 

func (oc *OperationContext) Retire() error

func (*OperationContext) Save 

func (oc *OperationContext) Save(s Subcontext) error

func (*OperationContext) StageFolder 

func (oc *OperationContext) StageFolder() string

func (*OperationContext) StartProgress 

func (oc *OperationContext) StartProgress()

func (*OperationContext) StartProgressWithInitialAndTotal 

func (oc *OperationContext) StartProgressWithInitialAndTotal(initialProgress float64, totalBytes int64)

func (*OperationContext) StartProgressWithTotalBytes 

func (oc *OperationContext) StartProgressWithTotalBytes(totalBytes int64)

type OperationError 

type OperationError struct {
	Type      string `json:"type"`
	Code      string `json:"code"`
	Message   string `json:"message"`
	Operation string `json:"operation"`
}

func (*OperationError) Error 

func (oe *OperationError) Error() string

func (*OperationError) Throw 

func (oe *OperationError) Throw() error

type Subcontext 

type Subcontext interface {
	// Key returns a unique string key used for storing
	// something under the context object
	Key() string

	// Data should return a pointer to the underlying struct
	// of the subcontext
	Data() interface{}
}

Source Files

View all Source files

Directories

Path Synopsis
mockharness

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.