Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

progressbar

package

Go to main page

Versions in this module

v1

v1.24.0

Oct 1, 2020

v1.23.0

Sep 14, 2020

v1.22.7

Sep 7, 2020

v1.22.6

Sep 6, 2020

v1.22.5

Sep 6, 2020

v1.22.4

Sep 6, 2020

v1.22.3

Sep 6, 2020

v1.22.2

Sep 6, 2020

v1.22.1

Sep 6, 2020

v1.22.0

Sep 6, 2020

Changes in this version

+ const DefaultBarStyle

+ var DefaultSpinnerStyle = []string

+ type Bar struct

+ func (b *Bar) Abort(drop bool)

+ func (b *Bar) Completed() bool

+ func (b *Bar) Current() int64

+ func (b *Bar) DecoratorAverageAdjust(start time.Time)

+ func (b *Bar) DecoratorEwmaUpdate(dur time.Duration)

+ func (b *Bar) GetContainer() *Progress

+ func (b *Bar) ID() int

+ func (b *Bar) IncrBy(n int)

+ func (b *Bar) IncrInt64(n int64)

+ func (b *Bar) Increment()

+ func (b *Bar) ProxyReader(r io.Reader) io.ReadCloser

+ func (b *Bar) SetCurrent(current int64)

+ func (b *Bar) SetPriority(priority int)

+ func (b *Bar) SetRefill(amount int64)

+ func (b *Bar) SetTotal(total int64, complete bool)

+ func (b *Bar) TraverseDecorators(cb func(decor.Decorator))

+ type BarFiller interface

+ Fill func(w io.Writer, reqWidth int, stat decor.Statistics)

+ func NewBarFiller(style string, reverse bool) BarFiller

+ func NewSpinnerFiller(style []string, alignment SpinnerAlignment) BarFiller

+ type BarFillerFunc func(w io.Writer, reqWidth int, stat decor.Statistics)

+ func (f BarFillerFunc) Fill(w io.Writer, reqWidth int, stat decor.Statistics)

+ type BarOption func(*bState)

+ func AppendDecorators(decorators ...decor.Decorator) BarOption

+ func BarExtender(filler BarFiller) BarOption

+ func BarFillerClearOnComplete() BarOption

+ func BarFillerMiddleware(middle func(BarFiller) BarFiller) BarOption

+ func BarFillerOnComplete(message string) BarOption

+ func BarID(id int) BarOption

+ func BarNoPop() BarOption

+ func BarOptOn(option BarOption, condition func() bool) BarOption

+ func BarPriority(priority int) BarOption

+ func BarQueueAfter(runningBar *Bar) BarOption

+ func BarRemoveOnComplete() BarOption

+ func BarReverse() BarOption

+ func BarStyle(style string) BarOption

+ func BarWidth(width int) BarOption

+ func MakeFillerTypeSpecificBarOption(typeChecker func(BarFiller) (interface{}, bool), cb func(interface{})) BarOption

+ func PrependDecorators(decorators ...decor.Decorator) BarOption

+ func SpinnerStyle(frames []string) BarOption

+ func TrimSpace() BarOption

+ type ContainerOption func(*pState)

+ func ContainerOptOn(option ContainerOption, condition func() bool) ContainerOption

+ func PopCompletedMode() ContainerOption

+ func WithDebugOutput(w io.Writer) ContainerOption

+ func WithManualRefresh(ch <-chan time.Time) ContainerOption

+ func WithOutput(w io.Writer) ContainerOption

+ func WithRefreshRate(d time.Duration) ContainerOption

+ func WithRenderDelay(ch <-chan struct{}) ContainerOption

+ func WithShutdownNotifier(ch chan struct{}) ContainerOption

+ func WithWaitGroup(wg *sync.WaitGroup) ContainerOption

+ func WithWidth(width int) ContainerOption

+ type LogFiller struct

+ Message string

+ func MultiBarLog(message string) LogFiller

+ func (l LogFiller) Fill(w io.Writer, reqWidth int, stat decor.Statistics)

+ type Progress struct

+ func NewWithContext(ctx context.Context, options ...ContainerOption) *Progress

+ func (p *Progress) Add(total int64, filler BarFiller, options ...BarOption) *Bar

+ func (p *Progress) AddBar(total int64, options ...BarOption) *Bar

+ func (p *Progress) AddSpinner(total int64, alignment SpinnerAlignment, options ...BarOption) *Bar

+ func (p *Progress) BarCount() int

+ func (p *Progress) Log(message string) *Progress

+ func (p *Progress) LogWithPriority(message string, priority int) *Progress

+ func (p *Progress) NewLine() *Progress

+ func (p *Progress) NewLineWithPriority(priority int) *Progress

+ func (p *Progress) UpdateBarPriority(b *Bar, priority int)

+ func (p *Progress) Wait()

+ type SpinnerAlignment int

+ const SpinnerOnLeft

+ const SpinnerOnMiddle

+ const SpinnerOnRight

v1.21.1

Sep 5, 2020

v1.21.0

Sep 5, 2020

Changes in this version

+ type Option func(p *ProgressBar)

+ func OptionClearOnFinish() Option

+ func OptionEnableColorCodes(colorCodes bool) Option

+ func OptionFullWidth() Option

+ func OptionOnCompletion(cmpl func()) Option

+ func OptionSetDescription(description string) Option

+ func OptionSetItsString(iterationString string) Option

+ func OptionSetPredictTime(predictTime bool) Option

+ func OptionSetRenderBlankState(r bool) Option

+ func OptionSetTheme(t Theme) Option

+ func OptionSetVisibility(visibility bool) Option

+ func OptionSetWidth(s int) Option

+ func OptionSetWriter(w io.Writer) Option

+ func OptionShowBytes(val bool) Option

+ func OptionShowCount() Option

+ func OptionShowIts() Option

+ func OptionSpinnerType(spinnerType int) Option

+ func OptionThrottle(duration time.Duration) Option

+ type ProgressBar struct

+ func Default(max int64, description ...string) *ProgressBar

+ func DefaultBytes(maxBytes int64, description ...string) *ProgressBar

+ func New(max int) *ProgressBar

+ func New64(max int64) *ProgressBar

+ func NewOptions(max int, options ...Option) *ProgressBar

+ func NewOptions64(max int64, options ...Option) *ProgressBar

+ func (p *ProgressBar) Add(num int) error

+ func (p *ProgressBar) Add64(num int64) error

+ func (p *ProgressBar) ChangeMax(newMax int)

+ func (p *ProgressBar) ChangeMax64(newMax int64)

+ func (p *ProgressBar) Clear() error

+ func (p *ProgressBar) Describe(description string)

+ func (p *ProgressBar) Finish() error

+ func (p *ProgressBar) GetMax() int

+ func (p *ProgressBar) GetMax64() int64

+ func (p *ProgressBar) Read(b []byte) (n int, err error)

+ func (p *ProgressBar) RenderBlank() error

+ func (p *ProgressBar) Reset()

+ func (p *ProgressBar) Set(num int) error

+ func (p *ProgressBar) Set64(num int64) error

+ func (p *ProgressBar) State() State

+ func (p *ProgressBar) Write(b []byte) (n int, err error)

+ type Reader struct

+ func (r *Reader) Close() (err error)

+ func (r *Reader) Read(p []byte) (n int, err error)

+ type State struct

+ CurrentBytes float64

+ CurrentPercent float64

+ KBsPerSecond float64

+ SecondsLeft float64

+ SecondsSince float64

+ type Theme struct

+ BarEnd string

+ BarStart string

+ Saucer string

+ SaucerHead string

+ SaucerPadding string