pkg

Documentation

Overview

Package pkg provides helpful base interfaces and struct definitions

Index

• type Base
  • func (base Base) Environment() (result []string, err error)
  • func (base Base) Info() (result map[string]string)
  • func (base Base) Install() error
  • func (base Base) Link() error
  • func (base Base) ListRemote() (result []string, err error)
  • func (base Base) PostInstall() error
  • func (base Base) PreDownload() error
  • func (base Base) PreInstall() error
  • func (base Base) Rollback() error
  • func (base Base) Switch() error
• type Pkg

Types

type Base

type Base struct {
	Version string
	Emitter *emission.Emitter
}

Base struct from which every plugin should inherit

func (Base) Environment

func (base Base) Environment() (result []string, err error)

Environment returns list of the all needed envionment variables

func (Base) Info

func (base Base) Info() (result map[string]string)

Info provides all the info needed for installation of the plugin

func (Base) Install

func (base Base) Install() error

Install hook

func (Base) Link

func (base Base) Link() error

Link hook

func (Base) ListRemote

func (base Base) ListRemote() (result []string, err error)

ListRemote returns list of the all available remote versions

func (Base) PostInstall

func (base Base) PostInstall() error

PostInstall hook

func (Base) PreDownload

func (base Base) PreDownload() error

PreDownload hook

func (Base) PreInstall

func (base Base) PreInstall() error

PreInstall hook

func (Base) Rollback

func (base Base) Rollback() error

Rollback hook

func (Base) Switch

func (base Base) Switch() error

Switch hook

type Pkg

type Pkg interface {
	PreDownload() error
	PreInstall() error
	Install() error
	PostInstall() error
	Switch() error
	Link() error
	Rollback() error
	Events() *emission.Emitter
	Environment() ([]string, error)
	ListRemote() ([]string, error)
	Info() map[string]string
	Bins() []string
	Dots() []string
}

Pkg plugin interface