jprogress

package module
v0.1.3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 10, 2024 License: MIT Imports: 9 Imported by: 1

Documentation

Overview

package jprogress is a library to render progress bars in terminal applications

Index

Constants

This section is empty.

Variables

View Source 
var (
	// Fill is the default character representing completed progress
	Fill byte = '='

	// Head is the default character that moves when progress is updated
	Head byte = '>'

	// Empty is the default character that represents the empty progress
	Empty byte = '-'

	// LeftEnd is the default character in the left most part of the progress indicator
	LeftEnd byte = '['

	// RightEnd is the default character in the right most part of the progress indicator
	RightEnd byte = ']'

	// Width is the default width of the progress bar
	Width = 70

	// ErrMaxCurrentReached is error when trying to set current value that exceeds the total value
	ErrMaxCurrentReached = errors.New("errors: current value is greater total value")
)
View Source 
var Out = os.Stdout

Out is the default writer to render progress bars to

View Source 
var RefreshInterval = time.Millisecond * 10

RefreshInterval in the default time duration to wait for refreshing the output

Functions

func Listen 

func Listen()

Listen listens for updates and renders the progress bars

func RemoveBar added in v0.1.1 

func RemoveBar(bar *Bar) error

RemoveBar remove bar from progress

func RemoveBarOnComplete added in v0.1.1 

func RemoveBarOnComplete(bar *Bar) error

RemoveBarOnComplete remove bar from progress when complete

func Start 

func Start()

Start starts the rendering the progress of progress bars using the DefaultProgress. It listens for updates using `bar.Set(n)` and new bars when added using `AddBar`

func Stop 

func Stop()

Stop stops listening

Types

type Bar 

type Bar struct {
	// Total of the total  for the progress bar
	Total int64

	// LeftEnd is character in the left most part of the progress indicator. Defaults to '['
	LeftEnd byte

	// RightEnd is character in the right most part of the progress indicator. Defaults to ']'
	RightEnd byte

	// Fill is the character representing completed progress. Defaults to '='
	Fill byte

	// Head is the character that moves when progress is updated.  Defaults to '>'
	Head byte

	// Empty is the character that represents the empty progress. Default is '-'
	Empty byte

	// TimeStated is time progress began
	TimeStarted time.Time

	// Width is the width of the progress bar
	Width int
	// contains filtered or unexported fields
}

Bar represents a progress bar

func AddBar 

func AddBar(total int) *Bar

AddBar creates a new progress bar and adds it to the default progress container

func Default added in v0.1.2 

func Default(total int, description ...string) *Bar

func Default64 added in v0.1.3 

func Default64(total int64, description ...string) *Bar

func NewBar 

func NewBar(total int) *Bar

NewBar returns a new progress bar

func NewBar64 added in v0.1.3 

func NewBar64(total int64) *Bar

NewBar64 returns a new progress bar

func (*Bar) Add added in v0.1.2 

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

Add increments the current value by num, time elapsed to current time and returns true. It returns false if the cursor has reached or exceeds total value.

func (*Bar) Add64 added in v0.1.3 

func (b *Bar) Add64(num int64) bool

Add64 increments the current value by num, time elapsed to current time and returns true. It returns false if the cursor has reached or exceeds total value.

func (*Bar) AppendCompleted 

func (b *Bar) AppendCompleted() *Bar

AppendCompleted appends the completion percent to the progress bar

func (*Bar) AppendETA 

func (b *Bar) AppendETA() *Bar

AppendETA append the eta to the progress bar

func (*Bar) AppendElapsed 

func (b *Bar) AppendElapsed() *Bar

AppendElapsed appends the time elapsed the be progress bar

func (*Bar) AppendFunc 

func (b *Bar) AppendFunc(f DecoratorFunc) *Bar

AppendFunc runs the decorator function and renders the output on the right of the progress bar

func (*Bar) AppendSlashNum added in v0.1.2 

func (b *Bar) AppendSlashNum() *Bar

AppendSlashNum append <processed num>/<total> to the progress bar

func (*Bar) AppendStr added in v0.1.2 

func (b *Bar) AppendStr(str string) *Bar

AppendStr append str to the progress bar

func (*Bar) Bytes 

func (b *Bar) Bytes() []byte

Bytes returns the byte presentation of the progress bar

func (*Bar) CompletedPercent 

func (b *Bar) CompletedPercent() float64

CompletedPercent return the percent completed

func (*Bar) CompletedPercentString 

func (b *Bar) CompletedPercentString() string

CompletedPercentString returns the formatted string representation of the completed percent

func (*Bar) Current 

func (b *Bar) Current() int

Current returns the current progress of the bar

func (*Bar) Current64 added in v0.1.3 

func (b *Bar) Current64() int64

Current64 returns the current progress of the bar

func (*Bar) Finish added in v0.1.2 

func (b *Bar) Finish() error

Finish set the current value to total, time elapsed to current time

func (*Bar) Incr 

func (b *Bar) Incr() bool

Incr increments the current value by 1, time elapsed to current time and returns true. It returns false if the cursor has reached or exceeds total value.

func (*Bar) IsComplete added in v0.1.1 

func (b *Bar) IsComplete() bool

CompletedPercent return the percent completed

func (*Bar) PrependCompleted 

func (b *Bar) PrependCompleted() *Bar

PrependCompleted prepends the precent completed to the progress bar

func (*Bar) PrependDesc 

func (b *Bar) PrependDesc(description string) *Bar

PrependDesc prepends <processed num>/<total> to the progress bar

func (*Bar) PrependElapsed 

func (b *Bar) PrependElapsed() *Bar

PrependElapsed prepends the time elapsed to the begining of the bar

func (*Bar) PrependFunc 

func (b *Bar) PrependFunc(f DecoratorFunc) *Bar

PrependFunc runs decorator function and render the output left the progress bar

func (*Bar) PrependSlashNum 

func (b *Bar) PrependSlashNum() *Bar

PrependSlashNum prepends <processed num>/<total> to the progress bar

func (*Bar) PrependStr added in v0.1.2 

func (b *Bar) PrependStr(str string) *Bar

PrependStr prepends str to the progress bar

func (*Bar) Set 

func (b *Bar) Set(n int) error

Set the current count of the bar. It returns ErrMaxCurrentReached when trying n exceeds the total value. This is atomic operation and concurrency safe.

func (*Bar) Set64 added in v0.1.3 

func (b *Bar) Set64(n int64) error

Set64 the current count of the bar. It returns ErrMaxCurrentReached when trying n exceeds the total value. This is atomic operation and concurrency safe.

func (*Bar) String 

func (b *Bar) String() string

String returns the string representation of the bar

func (*Bar) TimeElapsed 

func (b *Bar) TimeElapsed() time.Duration

TimeElapsed returns the time elapsed

func (*Bar) TimeElapsedString 

func (b *Bar) TimeElapsedString() string

TimeElapsedString returns the formatted string represenation of the time elapsed

type DecoratorFunc 

type DecoratorFunc func(b *Bar) string

DecoratorFunc is a function that can be prepended and appended to the progress bar

type Progress 

type Progress struct {
	// Out is the writer to render progress bars to
	Out io.Writer

	// Width is the width of the progress bars
	Width int

	// Bars is the collection of progress bars
	Bars []*Bar

	// RefreshInterval in the time duration to wait for refreshing the output
	RefreshInterval time.Duration
	// contains filtered or unexported fields
}

Progress represents the container that renders progress bars

func New 

func New() *Progress

New returns a new progress bar with defaults

func (*Progress) AddBar 

func (p *Progress) AddBar(total int) *Bar

AddBar creates a new progress bar and adds to the container

func (*Progress) Bypass 

func (p *Progress) Bypass() io.Writer

Bypass returns a writer which allows non-buffered data to be written to the underlying output

func (*Progress) Default added in v0.1.2 

func (p *Progress) Default(total int, description ...string) *Bar

Default creates a new progress bar and adds to the container

func (*Progress) Default64 added in v0.1.3 

func (p *Progress) Default64(total int64, description ...string) *Bar

Default64 creates a new progress bar and adds to the container

func (*Progress) Listen 

func (p *Progress) Listen()

Listen listens for updates and renders the progress bars

func (*Progress) RemoveBar added in v0.1.1 

func (p *Progress) RemoveBar(bar *Bar) error

func (*Progress) RemoveBarOnComplete added in v0.1.1 

func (p *Progress) RemoveBarOnComplete(bar *Bar) error

RemoveBarOnComplete remove bar from progress when complete

func (*Progress) SetOut 

func (p *Progress) SetOut(o io.Writer)

func (*Progress) SetRefreshInterval 

func (p *Progress) SetRefreshInterval(interval time.Duration)

func (*Progress) Start 

func (p *Progress) Start()

Start starts the rendering the progress of progress bars. It listens for updates using `bar.Set(n)` and new bars when added using `AddBar`

func (*Progress) Stop 

func (p *Progress) Stop()

Stop stops listening

Source Files

View all Source files

Directories

Path Synopsis
examples
multibar command
util
strutil
Package strutil provides various utilities for manipulating strings
 Package strutil provides various utilities for manipulating strings
time

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.