progressbar

Documentation

Index

• func InitProgressBarIfPossible() (ioUtils.ProgressMgr, *os.File, error)
• type ReaderProgressBar
  • func (p *ReaderProgressBar) Abort()
  • func (p *ReaderProgressBar) ActionWithProgress(reader io.Reader) (results io.Reader)
  • func (p *ReaderProgressBar) GetId() (Id int)
• type SimpleProgressBar
  • func (p *SimpleProgressBar) Abort()
  • func (p *SimpleProgressBar) ActionWithProgress(reader io.Reader) (results io.Reader)
  • func (p *SimpleProgressBar) GetId() (Id int)

Functions

func InitProgressBarIfPossible

func InitProgressBarIfPossible() (ioUtils.ProgressMgr, *os.File, error)

Initializes progress bar if possible (all conditions in 'shouldInitProgressBar' are met). Creates a log file and sets the Logger to it. Caller responsible to close the file. Returns nil, nil, err if failed.

Types

type ReaderProgressBar

type ReaderProgressBar struct {
	Id int
	// contains filtered or unexported fields
}

func (*ReaderProgressBar) Abort

func (p *ReaderProgressBar) Abort()

Abort aborts a progress indicator. Called on both successful and unsuccessful operations

func (*ReaderProgressBar) ActionWithProgress

func (p *ReaderProgressBar) ActionWithProgress(reader io.Reader) (results io.Reader)

Used to update the progress bar progress.

func (*ReaderProgressBar) GetId

func (p *ReaderProgressBar) GetId() (Id int)

GetId Returns the ProgressBar ID

type SimpleProgressBar

type SimpleProgressBar struct {
	Id int
	// contains filtered or unexported fields
}

func (*SimpleProgressBar) Abort

func (p *SimpleProgressBar) Abort()

Abort aborts a progress indicator. Called on both successful and unsuccessful operations

func (*SimpleProgressBar) ActionWithProgress

func (p *SimpleProgressBar) ActionWithProgress(reader io.Reader) (results io.Reader)

Usesd to update the progress bar progress.

func (*SimpleProgressBar) GetId

func (p *SimpleProgressBar) GetId() (Id int)

GetId Returns the ProgressBar ID