bar

Documentation

Index

• Variables
• type Container
  • func New() (*Container, error)
  • func (b *Container) GetScreenDimensions() (cols int, lines int)
  • func (b *Container) New(total int64, prepend string) *ProgressBar
• type ProgressBar
  • func (p *ProgressBar) IncrBy(delta int64)
  • func (p *ProgressBar) Write(bs []byte) (n int, err error)

Variables

var (
	// Pretty defines if use pretty print
	Pretty = true
)

Types

type Container

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

Container holds attributes of a bar

func New

func New() (*Container, error)

New creates a BarContainer

func (*Container) GetScreenDimensions

func (b *Container) GetScreenDimensions() (cols int, lines int)

GetScreenDimensions gets the dimensions of

func (*Container) New

func (b *Container) New(total int64, prepend string) *ProgressBar

New creates a ProgressBar

type ProgressBar

type ProgressBar struct {
	Container   *Container
	Progress    int64
	Total       int64
	Speed       float64
	StartTime   time.Time
	CurrentTime time.Time
	Prepend     string
	// contains filtered or unexported fields
}

ProgressBar holds attributes of a bar

func (*ProgressBar) IncrBy

func (p *ProgressBar) IncrBy(delta int64)

IncrBy increate progress by an number

func (*ProgressBar) Write

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

Write implement io.Writer