progress

package

v0.3.0 Latest Latest Go to latest Published: Oct 4, 2025 License: MIT Imports: 2 Imported by: 1

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/f4n4t/go-release

Links

Open Source Insights

Documentation ¶

Index ¶

func DefaultProgressBar[T int64 | uint64 | int](totalLength T, showBytes bool, desc ...string) *progressbar.ProgressBar
type NoOpProgressBar
type Progress
- func NewProgressBar[T int64 | uint64 | int](showProgress bool, totalLength T, showBytes bool, desc ...string) Progress
type RealProgressBar

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func DefaultProgressBar ¶

func DefaultProgressBar[T int64 | uint64 | int](totalLength T, showBytes bool, desc ...string) *progressbar.ProgressBar

DefaultProgressBar returns a *progressbar.ProgressBar with customized settings

Types ¶

type NoOpProgressBar ¶

type NoOpProgressBar struct{}

NoOpProgressBar is a progress bar that does nothing

func (*NoOpProgressBar) Cancel ¶

func (p *NoOpProgressBar) Cancel()

func (*NoOpProgressBar) ChangeMax ¶

func (p *NoOpProgressBar) ChangeMax(value int)

func (*NoOpProgressBar) ChangeMax64 ¶

func (p *NoOpProgressBar) ChangeMax64(value int64)

func (*NoOpProgressBar) Close ¶

func (p *NoOpProgressBar) Close() error

func (*NoOpProgressBar) Finish ¶

func (p *NoOpProgressBar) Finish() error

func (*NoOpProgressBar) Read ¶

func (p *NoOpProgressBar) Read(buf []byte) (int, error)

func (*NoOpProgressBar) Set ¶

func (p *NoOpProgressBar) Set(value int) error

func (*NoOpProgressBar) Set64 ¶

func (p *NoOpProgressBar) Set64(value int64) error

func (*NoOpProgressBar) Write ¶

func (p *NoOpProgressBar) Write(buf []byte) (int, error)

type Progress ¶

type Progress interface {
	Set(value int) error
	Set64(value int64) error
	Finish() error
	Cancel()
	ChangeMax(value int)
	ChangeMax64(value int64)
	Read(buf []byte) (int, error)
	Close() error
	Write(buf []byte) (int, error)
}

Progress is an interface to represent a progress tracking mechanism with methods to set, update, and finalize progress.

func NewProgressBar ¶

func NewProgressBar[T int64 | uint64 | int](showProgress bool, totalLength T, showBytes bool, desc ...string) Progress

NewProgressBar returns a new Progress interface

type RealProgressBar ¶

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

RealProgressBar is a progress bar that uses schollz/progressbar

func (*RealProgressBar) Cancel ¶

func (p *RealProgressBar) Cancel()

func (*RealProgressBar) ChangeMax ¶

func (p *RealProgressBar) ChangeMax(value int)

func (*RealProgressBar) ChangeMax64 ¶

func (p *RealProgressBar) ChangeMax64(value int64)

func (*RealProgressBar) Close ¶

func (p *RealProgressBar) Close() error

func (*RealProgressBar) Finish ¶

func (p *RealProgressBar) Finish() error

func (*RealProgressBar) Read ¶

func (p *RealProgressBar) Read(buf []byte) (int, error)

func (*RealProgressBar) Set ¶

func (p *RealProgressBar) Set(value int) error

func (*RealProgressBar) Set64 ¶

func (p *RealProgressBar) Set64(value int64) error

func (*RealProgressBar) Write ¶

func (p *RealProgressBar) Write(buf []byte) (int, error)

Source Files ¶

View all Source files

progress.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL