bar

Documentation

Overview

Package bar provides a progress bar.

Index

• type ProgressBar
  • func NewBar(num uint64) *ProgressBar
  • func NewBufferedBar(num uint64, buffer int) *ProgressBar
  • func (b *ProgressBar) Close() error
  • func (b *ProgressBar) Finish() error
  • func (b *ProgressBar) Inc() error

Types

type ProgressBar

type ProgressBar struct {
	sync.Mutex
	// contains filtered or unexported fields
}

ProgressBar is a wrapper for schollz/progressbar.

func NewBar

func NewBar(num uint64) *ProgressBar

NewBar returns a new ProgressBar with the maximum set to the given number and the default buffer size; returns a spinner if the provided number is too big or zero.

func NewBufferedBar

func NewBufferedBar(num uint64, buffer int) *ProgressBar

NewBufferedBar returns a new ProgressBar with the maximum set to the given number and the given buffer size; returns a spinner if the provided number is too big or zero.

func (*ProgressBar) Close

func (b *ProgressBar) Close() error

Close closes the bar.

func (*ProgressBar) Finish

func (b *ProgressBar) Finish() error

Finish fills the bar.

func (*ProgressBar) Inc

func (b *ProgressBar) Inc() error

Inc increments the progress bar by the amount configured by it's buffer.