operate

Documentation

Index

• Variables
• func CleanDownloadsApply(params *buse.CleanDownloadsApplyParams, consumer *state.Consumer) (*buse.CleanDownloadsApplyResult, error)
• func CleanDownloadsSearch(params *buse.CleanDownloadsSearchParams, consumer *state.Consumer) (*buse.CleanDownloadsSearchResult, error)
• func DownloadInstallSource(oc *OperationContext, file eos.File, destPath string) error
• func GameFindUploads(ctx *mansion.Context, conn *jsonrpc2.Conn, req *jsonrpc2.Request) (*buse.GameFindUploadsResult, error)
• func NewStateConsumer(params *NewStateConsumerParams) (*state.Consumer, error)
• func Start(ctx context.Context, mansionContext *mansion.Context, conn *jsonrpc2.Conn, ...) (err error)
• type CommitInstallParams
• type InstallSubcontext
  • func (mt *InstallSubcontext) Data() interface{}
  • func (mt *InstallSubcontext) Key() string
• type InstallSubcontextState
• type MetaSubcontext
  • func (mt *MetaSubcontext) Data() interface{}
  • func (mt *MetaSubcontext) Key() string
• type NewStateConsumerParams
• type OperationContext
  • func LoadContext(conn *jsonrpc2.Conn, ctx context.Context, mansionContext *mansion.Context, ...) (*OperationContext, error)
  • func (oc *OperationContext) Consumer() *state.Consumer
  • func (oc *OperationContext) EndProgress()
  • func (oc *OperationContext) Load(s Subcontext)
  • func (oc *OperationContext) MansionContext() *mansion.Context
  • func (oc *OperationContext) Retire() error
  • func (oc *OperationContext) Save(s Subcontext) error
  • func (oc *OperationContext) StageFolder() string
  • func (oc *OperationContext) StartProgress()
  • func (oc *OperationContext) StartProgressWithInitialAndTotal(initialProgress float64, totalBytes int64)
  • func (oc *OperationContext) StartProgressWithTotalBytes(totalBytes int64)
• type OperationError
  • func (oe *OperationError) Error() string
  • func (oe *OperationError) Throw() error
• type Subcontext

Variables

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.

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

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

Functions

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 DownloadInstallSource

func DownloadInstallSource(oc *OperationContext, file eos.File, destPath string) error

func GameFindUploads

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

func NewStateConsumer

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

func Start

func Start(ctx context.Context, mansionContext *mansion.Context, conn *jsonrpc2.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 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 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 *jsonrpc2.Conn
	Ctx  context.Context

	// Optional
	LogFile *os.File
}

type OperationContext

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

func LoadContext

func LoadContext(conn *jsonrpc2.Conn, ctx context.Context, mansionContext *mansion.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) MansionContext

func (oc *OperationContext) MansionContext() *mansion.Context

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{}
}