selfupdate

Documentation

Index

• Variables
• type CheckInput
• type Checker
  • func NewChecker(opts ...Option) *Checker
  • func (c *Checker) Check(ctx context.Context, input *CheckInput) (*UpdateResult, error)
  • func (c *Checker) CheckAsync(ctx context.Context, input *CheckInput) <-chan *UpdateResult
  • func (c *Checker) Update(ctx context.Context, input *UpdateInput, progress func(UpdateProgress)) error
• type Option
  • func WithBaseURL(baseURL string) Option
  • func WithDownloadBaseURL(url string) Option
  • func WithHTTPClient(client *http.Client) Option
  • func WithTimeout(timeout time.Duration) Option
• type UpdateInput
• type UpdateProgress
• type UpdateResult

Variables

var (
	ErrDevBuild      = errors.New("cannot update a development build")
	ErrAlreadyLatest = errors.New("already running the latest version")
	ErrChecksum      = errors.New("checksum verification failed")
)

Types

type CheckInput

type CheckInput struct {
	Version string
}

type Checker

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

func NewChecker

func NewChecker(opts ...Option) *Checker

func (*Checker) Check

func (c *Checker) Check(ctx context.Context, input *CheckInput) (*UpdateResult, error)

func (*Checker) CheckAsync

func (c *Checker) CheckAsync(ctx context.Context, input *CheckInput) <-chan *UpdateResult

func (*Checker) Update

func (c *Checker) Update(ctx context.Context, input *UpdateInput, progress func(UpdateProgress)) error

type Option

type Option func(*Checker)

func WithBaseURL

func WithBaseURL(baseURL string) Option

func WithDownloadBaseURL

func WithDownloadBaseURL(url string) Option

func WithHTTPClient

func WithHTTPClient(client *http.Client) Option

func WithTimeout

func WithTimeout(timeout time.Duration) Option

type UpdateInput

type UpdateInput struct {
	CurrentVersion string
	TargetVersion  string
}

type UpdateProgress

type UpdateProgress struct {
	Stage   string
	Message string
}

type UpdateResult

type UpdateResult struct {
	UpdateAvailable bool   `json:"update_available"`
	LatestVersion   string `json:"latest_version"`
	CurrentVersion  string `json:"current_version"`
	ReleaseURL      string `json:"release_url"`
}