multiprogressbar

README

Go Multi Progress Bar

---

Go multi progress bar wraps around schollz/progressbar.

The library might work for simple cases only and is not tested extensively.

The API might introduce breaking changes from commit to commit for now.

Why another multi progress bar?

Iam aware of the working and tested multi progress bars out there. Use them if you want a battle-tested library.

I am using schollz/progressbar heavily, because it is simple and covers all my cases, except multiple progress bars.

Installation

go-multiprogressbar is compatible with modern Go releases and modules enabled.

go get github.com/IceflowRE/go-multiprogressbar

will resolve and add the package to the current development module, along with its dependencies.

Or just import it and run go get afterwards

import "github.com/IceflowRE/go-multiprogressbar"

Usage

Import

import "github.com/IceflowRE/go-multiprogressbar"

Basic usage

// create a new multi progressbar with default output to os.Stdout
mpb := multiprogressbar.New()
// add progressbars
for _, pBar := range []*progressbar.ProgressBar{
    progressbar.New(150),
    progressbar.New(200),
    progressbar.New(250),
} {
    mpb.Add(pBar)
}

for val := 0; val < 300; val++ {
    time.Sleep(10 * time.Millisecond)
    barId := val % 3
    mpb.Get(barId).Add(1)
}

Contributing

Every contribution and talk about the structure and organization of the project are always welcome.

Commit titles must follow this pattern [<category>] <Good Description> e.g. [gen] Fix file permissions.

Testing

Nothing to see here.

Thanks

A huge thanks to @schollz for this simple and still highly configurable progressbar library!

MIT License

Copyright 2023-present Iceflower S (iceflower@gmx.de)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Documentation

Index

• type MultiProgressBar
  • func New() *MultiProgressBar
  • func NewOptions(options ...Option) *MultiProgressBar
  • func (mpb *MultiProgressBar) Add(pBar *progressbar.ProgressBar) *progressbar.ProgressBar
  • func (mpb *MultiProgressBar) BarCount() int
  • func (mpb *MultiProgressBar) End() error
  • func (mpb *MultiProgressBar) Finish() error
  • func (mpb *MultiProgressBar) Get(idx int) *progressbar.ProgressBar
  • func (mpb *MultiProgressBar) RenderBlank() error
• type Option
  • func OptionSetWriter(writer io.Writer) Option

Types

type MultiProgressBar

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

func New

func New() *MultiProgressBar

func NewOptions

func NewOptions(options ...Option) *MultiProgressBar

NewOptions creates a new multi progressbar with passed options.

func (*MultiProgressBar) Add

func (mpb *MultiProgressBar) Add(pBar *progressbar.ProgressBar) *progressbar.ProgressBar

Add a progress bar. This will change the writer of the progress bar. Do not change the writer afterwards! Not thread safe. Return the passed progress bar.

func (*MultiProgressBar) BarCount

func (mpb *MultiProgressBar) BarCount() int

func (*MultiProgressBar) End

func (mpb *MultiProgressBar) End() error

End Move cursor to the end of the progress bars. Not thread safe.

func (*MultiProgressBar) Finish

func (mpb *MultiProgressBar) Finish() error

Finish calls Finish on all progress bars. If an error is thrown, Finish might not be called on all bars. This will also call End.

func (*MultiProgressBar) Get

func (mpb *MultiProgressBar) Get(idx int) *progressbar.ProgressBar

Get returns the progressbar.Progressbar with the given index. Will panic if the index does not exist.

func (*MultiProgressBar) RenderBlank

func (mpb *MultiProgressBar) RenderBlank() error

RenderBlank calls RenderBlank on all progress bars. If an error is thrown, RenderBlank might not be called on all bars.

type Option

type Option func(p *MultiProgressBar)

Option is the type all options need to adhere to

func OptionSetWriter

func OptionSetWriter(writer io.Writer) Option

OptionSetWriter sets the output writer. Unknown behaviour if called while using the multi progress bar.