timetrack

Documentation

Overview

Package timetrack tracks the progress and estimates completion of a task.

Index

• type Estimator
  • func Start() Estimator
  • func (v Estimator) Completed(total float64) (totalTime time.Duration, speed float64)
  • func (v Estimator) Estimate(completed, total float64) (Timings, bool)
• type Throttle
  • func (t *Throttle) Reset()
  • func (t *Throttle) ShouldOutput(interval time.Duration) bool
• type Timings

Types

type Estimator

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

Estimator estimates the completion of a task.

func Start

func Start() Estimator

Start returns an Estimator object.

func (Estimator) Completed

func (v Estimator) Completed(total float64) (totalTime time.Duration, speed float64)

Completed computes the duration and speed (total per second).

func (Estimator) Estimate

func (v Estimator) Estimate(completed, total float64) (Timings, bool)

Estimate estimates the completion of a task given the current progress as indicated by ration of completed/total.

type Throttle

type Throttle int64

Throttle throttles UI updates to a specific interval.

func (*Throttle) Reset

func (t *Throttle) Reset()

Reset resets the throttle.

func (*Throttle) ShouldOutput

func (t *Throttle) ShouldOutput(interval time.Duration) bool

ShouldOutput returns true if it's ok to produce output given the for a given time interval.

type Timings

type Timings struct {
	PercentComplete  float64
	EstimatedEndTime time.Time
	Remaining        time.Duration
	SpeedPerSecond   float64
}

Timings returns task progress and timings.