progress

Documentation

Index

• Variables
• func Cancel(token types.ProgressToken)
• func CleanupChannels()
• func IsCanceled(token types.ProgressToken) bool
• type Tracker
  • func NewTestTracker(channel chan types.ProgressParams, cancelChannel chan bool) *Tracker
  • func NewTracker(cancellable bool) *Tracker
  • func (t *Tracker) Begin(title string)
  • func (t *Tracker) BeginUnquantifiableLength(title, message string)
  • func (t *Tracker) BeginWithMessage(title, message string)
  • func (t *Tracker) CancelOrDone(onCancel func(), doneCh <-chan struct{})
  • func (t *Tracker) End()
  • func (t *Tracker) EndWithMessage(message string)
  • func (t *Tracker) GetCancelChannel() chan bool
  • func (t *Tracker) GetChannel() chan types.ProgressParams
  • func (t *Tracker) GetToken() types.ProgressToken
  • func (t *Tracker) IsCanceled() bool
  • func (t *Tracker) Report(percentage int)
  • func (t *Tracker) ReportWithMessage(percentage int, message string)

Variables

var ToServerProgressChannel = make(chan types.ProgressParams, 100000)

Functions

func Cancel

func Cancel(token types.ProgressToken)

func CleanupChannels

func CleanupChannels()

CleanupChannels is Test-Only. Don't use for non-test code

func IsCanceled

func IsCanceled(token types.ProgressToken) bool

Types

type Tracker

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

func NewTestTracker

func NewTestTracker(channel chan types.ProgressParams, cancelChannel chan bool) *Tracker

func NewTracker

func NewTracker(cancellable bool) *Tracker

func (*Tracker) Begin

func (t *Tracker) Begin(title string)

func (*Tracker) BeginUnquantifiableLength

func (t *Tracker) BeginUnquantifiableLength(title, message string)

func (*Tracker) BeginWithMessage

func (t *Tracker) BeginWithMessage(title, message string)

func (*Tracker) CancelOrDone

func (t *Tracker) CancelOrDone(onCancel func(), doneCh <-chan struct{})

func (*Tracker) End

func (t *Tracker) End()

func (*Tracker) EndWithMessage

func (t *Tracker) EndWithMessage(message string)

func (*Tracker) GetCancelChannel

func (t *Tracker) GetCancelChannel() chan bool

func (*Tracker) GetChannel

func (t *Tracker) GetChannel() chan types.ProgressParams

func (*Tracker) GetToken

func (t *Tracker) GetToken() types.ProgressToken

func (*Tracker) IsCanceled

func (t *Tracker) IsCanceled() bool

func (*Tracker) Report

func (t *Tracker) Report(percentage int)

func (*Tracker) ReportWithMessage

func (t *Tracker) ReportWithMessage(percentage int, message string)