optracker

Documentation

Index

• Variables
• type OpTracker
  • func New(w io.Writer) *OpTracker
  • func (t *OpTracker) Add(msg string, minStart time.Time) OperationID
  • func (t *OpTracker) AllDone()
  • func (t *OpTracker) Cancel(id OperationID)
  • func (t *OpTracker) Done(id OperationID, minDuration time.Duration)
  • func (t *OpTracker) Fail(id OperationID, err error)
• type OperationID

Variables

var ErrCanceled = errors.New("operation canceled")

Types

type OpTracker

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

func New

func New(w io.Writer) *OpTracker

func (*OpTracker) Add

func (t *OpTracker) Add(msg string, minStart time.Time) OperationID

Add creates a new item on the operations tracker returning the ID for that op. minStart is the time at which the tracker will start to show the task as in progress.

This function is safe to call on a Nil OpTracker and will no-op in that case

func (*OpTracker) AllDone

func (t *OpTracker) AllDone()

AllDone marks all ops as done. This function is safe to call on a Nil OpTracker and will no-op in that case

func (*OpTracker) Cancel

func (t *OpTracker) Cancel(id OperationID)

Cancel marks the operation as canceled. It is equivalent to t.Fail(id, ErrCanceled).

func (*OpTracker) Done

func (t *OpTracker) Done(id OperationID, minDuration time.Duration)

Done marks the given operation as done

This function is safe to call on a Nil OpTracker and will no-op in that case

func (*OpTracker) Fail

func (t *OpTracker) Fail(id OperationID, err error)

Fail marks the operation as failed with the given error

This function is safe to call on a Nil OpTracker and will no-op in that case

type OperationID

type OperationID int

const NoOperationID OperationID = -1