loudprogress

README

loudprogress

Documentation

Index

• func Render_Bold(size uint64, writer io.Writer) (func(uint64), func(uint64))
• func Render_BoldRainbow(size uint64, writer io.Writer) (func(uint64), func(uint64))
• func Render_Simple(size uint64, writer io.Writer) (func(uint64), func(uint64))
• type LoudProgress
  • func NewLoudProgress(size uint64, render_func RenderFunc) *LoudProgress
  • func (lp *LoudProgress) ExpandSize(size uint64) error
  • func (lp *LoudProgress) GetWait() time.Duration
  • func (lp *LoudProgress) Increment() (uint64, error)
  • func (lp *LoudProgress) IsFinished() bool
  • func (lp *LoudProgress) IsRunning() bool
  • func (lp *LoudProgress) SetWait(wait time.Duration) error
  • func (lp *LoudProgress) SetWriter(writer io.Writer)
  • func (lp *LoudProgress) Start() error
• type RenderFunc

Functions

func Render_Bold

func Render_Bold(size uint64, writer io.Writer) (func(uint64), func(uint64))

Bold progress bar

func Render_BoldRainbow

func Render_BoldRainbow(size uint64, writer io.Writer) (func(uint64), func(uint64))

Bold rainbow progress bar

func Render_Simple

func Render_Simple(size uint64, writer io.Writer) (func(uint64), func(uint64))

Simple progress bar

Types

type LoudProgress

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

func NewLoudProgress

func NewLoudProgress(size uint64, render_func RenderFunc) *LoudProgress

Generate new LoudProgress

func (*LoudProgress) ExpandSize

func (lp *LoudProgress) ExpandSize(size uint64) error

Set size

func (*LoudProgress) GetWait

func (lp *LoudProgress) GetWait() time.Duration

Get wait

func (*LoudProgress) Increment

func (lp *LoudProgress) Increment() (uint64, error)

Method for increment current number () -> (lp.current, err)

func (*LoudProgress) IsFinished

func (lp *LoudProgress) IsFinished() bool

Get is_finished

func (*LoudProgress) IsRunning

func (lp *LoudProgress) IsRunning() bool

Get is_running

func (*LoudProgress) SetWait

func (lp *LoudProgress) SetWait(wait time.Duration) error

Set wait

func (*LoudProgress) SetWriter

func (lp *LoudProgress) SetWriter(writer io.Writer)

Set writer

func (*LoudProgress) Start

func (lp *LoudProgress) Start() error

Start rendering progress

type RenderFunc

type RenderFunc func(size uint64, writer io.Writer) (func(uint64), func(uint64)) // alias for rendering function