progress_bar

README

progress_bar

Go Progress Bar

Features

progress_bar creates a single customizable progress bar for Linux terminal.

Installation

go get -u github.com/ermanimer/progress_bar

Functions

DefaultProgressBar(totalValue float64) *ProgressBar

Creates a progress bar with default parameters and given total value.

Parameter	Description
totalValue	Total value of progress bar

Default parameters:

Default Parameter	Value
Default Schema	[{bar}][{percent}][{current}/{total}][Elapsed: {elapsed}s Remaining:{remaining}s]
Default Filled Character	#
Default Blank Character	.
Default Length	50

NewProgressBar(output io.Writer, schema string, filledCharacter string, blankCharacter string, length float64, totalValue float64) *ProgressBar

Creates a progress bar with default parameters and given total value.

Parameter	Description
output	Output of progress bar
schema	Schema of progress bar
filledCharacter	Filled character of progress bar
blankCharacter	Blank character of progress bar
length	Length of progress bar
totalValue	Total value of progress bar

Schema Variables:

Schema Variable	Value
{bar}	Bar of progress bar
{percent}	Percentage of progress bar
{current}	Current value of progress bar
{total}	Total value of progress bar
{elapsed}	Elapsed duration
{remaining}	Estimated remaining duration

Methods

Start() error

Starts progress bar.

Stop() error

Stops progress bar.

Update(value float64) error

Updates progress bar with given value and stops progress bar is total value is reached.

Parameter	Description
value	Current value of progress bar

Usage

Default Progress Bar:

package main

import (
	"fmt"
	"time"

	"github.com/ermanimer/progress_bar"
)

func main() {
	//create new progress bar
	pb := progress_bar.DefaultProgressBar(100)
	//start
	err := pb.Start()
	if err != nil {
		fmt.Println(err.Error())
		return
	}
	//update
	for value := 1; value <= 100; value++ {
		time.Sleep(20 * time.Millisecond)
		err := pb.Update(float64(value))
		if err != nil {
			fmt.Println(err.Error())
			break
		}
	}
}

Terminal Output:

New Progress Bar:

package main

import (
	"fmt"
	"os"
	"time"

	"github.com/ermanimer/progress_bar"
)

func main() {
	//create parameters
	output := os.Stdout
	schema := "({bar}) ({percent}) ({current} of {total} completed)"
	filledCharacter := "="
	blankCharacter := "-"
	var length float64 = 60
	var totalValue float64 = 80
	//create new progress bar
	pb := progress_bar.NewProgressBar(output, schema, filledCharacter, blankCharacter, length, totalValue)
	//start
	err := pb.Start()
	if err != nil {
		fmt.Println(err.Error())
		return
	}
	//update
	for value := 1; value <= 80; value++ {
		time.Sleep(20 * time.Millisecond)
		err := pb.Update(float64(value))
		if err != nil {
			fmt.Println(err.Error())
			break
		}
	}
}

Terminal Output:

New Progress Bar Colored With color:

package main

import (
	"fmt"
	"os"
	"time"

	"github.com/ermanimer/color/v2"
	"github.com/ermanimer/progress_bar"
)

func main() {
	//create parameters
	output := os.Stdout
	//create color functions
	orange := (&color.Color{Foreground: 172}).SprintFunction()
	grey := (&color.Color{Foreground: 246}).SprintFunction()
	//create colored schema
	bar := orange("{bar}")
	percent := grey("{percent}")
	schema := fmt.Sprintf("%s %s", bar, percent)
	filledCharacter := "▆"
	blankCharacter := " "
	var length float64 = 50
	var totalValue float64 = 80
	//create new progress bar
	pb := progress_bar.NewProgressBar(output, schema, filledCharacter, blankCharacter, length, totalValue)
	//start
	err := pb.Start()
	if err != nil {
		fmt.Println(err.Error())
		return
	}
	//update
	for value := 1; value <= 80; value++ {
		time.Sleep(20 * time.Millisecond)
		err := pb.Update(float64(value))
		if err != nil {
			fmt.Println(err.Error())
			break
		}
	}
}

Terminal Output:

References

• ANSI Escape Codes, Wikipedia
• Build Your Own Command Line With ANSI Escape Codes, Haoyi's Programming Blog

Documentation

Index

• type ProgressBar
  • func DefaultProgressBar(totalValue float64) *ProgressBar
  • func NewProgressBar(output io.Writer, schema string, filledCharacter string, blankCharacter string, ...) *ProgressBar
  • func (pb *ProgressBar) Start() error
  • func (pb *ProgressBar) Stop() error
  • func (pb *ProgressBar) Update(value float64) error

Types

type ProgressBar

type ProgressBar struct {
	Output            io.Writer
	Schema            string
	FilledCharacter   string
	BlankCharacter    string
	Length            float64
	CurrentValue      float64
	TotalValue        float64
	ElapsedDuration   float64
	RemainingDuration float64
	// contains filtered or unexported fields
}

func DefaultProgressBar

func DefaultProgressBar(totalValue float64) *ProgressBar

func NewProgressBar

func NewProgressBar(output io.Writer, schema string, filledCharacter string, blankCharacter string, length float64, totalValue float64) *ProgressBar

func (*ProgressBar) Start

func (pb *ProgressBar) Start() error

func (*ProgressBar) Stop

func (pb *ProgressBar) Stop() error

func (*ProgressBar) Update

func (pb *ProgressBar) Update(value float64) error