barpool

Documentation

Overview

Package barpool provides access to the global pool of progress bars, so they could be rendered altogether.

Index

• func Disable(v bool)
• func Start() error
• func Stop()
• type Bar
  • func AddWithTemplate(format string, total int) Bar
  • func NewSingleProgress(format string, total int) Bar

Functions

func Disable

func Disable(v bool)

Disable sets progress bar to be no-op if v==true

func Start

func Start() error

Start starts the global pool Must be called after all progress bars were added

func Stop

func Stop()

Stop stops the global pool

Types

type Bar

type Bar interface {
	Add(value int)
	Increment()
	Start()
	Finish()
	NewProxyReader(r io.Reader) *pb.Reader
}

Bar is an interface for progress bar

func AddWithTemplate

func AddWithTemplate(format string, total int) Bar

AddWithTemplate adds bar with the given template to the global pool

func NewSingleProgress

func NewSingleProgress(format string, total int) Bar

NewSingleProgress returns progress bar with given template