progress

Documentation

Index

• type Progress
  • func NewProgress(maxBytes int64, description string, intervalToShow time.Duration) *Progress
  • func (p *Progress) Add(num int)
  • func (p *Progress) Add64(num int64)
  • func (p *Progress) Finish()
• type Reader
  • func NewReader(r io.Reader, bar *Progress) Reader
  • func (r *Reader) Close() (err error)
  • func (r *Reader) Read(p []byte) (n int, err error)

Types

type Progress

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

Progress tracks progress rendering at a certain interval on a new line the current percentage of bytes added from a total of maxBytes

Inspired by https://github.com/schollz/progressbar

func NewProgress

func NewProgress(maxBytes int64, description string, intervalToShow time.Duration) *Progress

NewProgress initialize a new progress ready to use

func (*Progress) Add

func (p *Progress) Add(num int)

Add will add the specified amount to the progressbar

func (*Progress) Add64

func (p *Progress) Add64(num int64)

Add64 will add the specified amount to the progressbar

func (*Progress) Finish

func (p *Progress) Finish()

Finish sets the current progress to 100%

type Reader

type Reader struct {
	io.Reader
	// contains filtered or unexported fields
}

Reader will wrap an io.Reader adding progress functionality

func NewReader

func NewReader(r io.Reader, bar *Progress) Reader

NewReader return a new Reader with a given progress

func (*Reader) Close

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

Close the reader when it implements io.Closer

func (*Reader) Read

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

Read will read n bytes and track progress