progressbar

README

progressbar

A simple progress bar for golang projects. I created that because there was a long processes in some project and I didn't know what was the progression.

Installation

go get -u github.com/disco07/progressbar

Usage

Basic usage

bar := progressbar.Default(100)
for i := 0; i < 100; i++ {
    bar.Add(1)
    time.Sleep(100 * time.Millisecond)
}

Contributing 🤝

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

📝 License

Documentation

Index

• type Bar
  • func Default(end int64) *Bar
  • func DefaultBytes(end int64) *Bar
  • func New(end int64) *Bar
  • func (b *Bar) Add(num int) error
  • func (b *Bar) Read(byte []byte) (n int, err error)
  • func (b *Bar) SetTheme(t Theme)
  • func (b *Bar) Write(byte []byte) (n int, err error)
• type Reader
  • func NewReader(r io.Reader, bar *Bar) Reader
  • func (r *Reader) Read(byte []byte) (int, error)
• type Theme

Types

type Bar

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

func Default

func Default(end int64) *Bar

Default is a basic usage of progress bar. In parameter, the max size of things you want to view progress. It returns a pointer of Bar.

func DefaultBytes

func DefaultBytes(end int64) *Bar

func New

func New(end int64) *Bar

func (*Bar) Add

func (b *Bar) Add(num int) error

Add is a func who add the number passed as a parameter to the progress bar.

func (*Bar) Read

func (b *Bar) Read(byte []byte) (n int, err error)

Read implement io.Reader

func (*Bar) SetTheme

func (b *Bar) SetTheme(t Theme)

func (*Bar) Write

func (b *Bar) Write(byte []byte) (n int, err error)

Write implement io.Writer

type Reader

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

Reader is the progressbar io.Reader.

func NewReader

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

NewReader return a new Reader with a given progress bar.

func (*Reader) Read

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

Read will read the data and add the number of bytes to the progressbar

type Theme

type Theme struct {
	GraphType  string
	GraphStart string
	GraphEnd   string
	GraphWidth int64
	// contains filtered or unexported fields
}