progress

Documentation

Index

• func WithMessage(m ...any) opt
• func WithTitle(t ...any) opt
• func WithTodo(s int64) opt
• func WithUnit(u string) opt
• func WithWidth(w int) opt
• type Bar
  • func New(opts ...opt) *Bar
  • func (b *Bar) Did(size int64, message ...any)
  • func (b *Bar) Doing(size int64, message ...any)
  • func (b *Bar) Finished(message ...any)
  • func (b *Bar) Reset(opts ...opt)
  • func (b *Bar) Start()
  • func (b *Bar) Todo(size int64)

Functions

func WithMessage

func WithMessage(m ...any) opt

func WithTitle

func WithTitle(t ...any) opt

func WithTodo

func WithTodo(s int64) opt

func WithUnit

func WithUnit(u string) opt

func WithWidth

func WithWidth(w int) opt

Types

type Bar

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

func New

func New(opts ...opt) *Bar

New creates a new progress meter

func (*Bar) Did

func (b *Bar) Did(size int64, message ...any)

Did increases the amount of work which has been done

func (*Bar) Doing

func (b *Bar) Doing(size int64, message ...any)

Doing indicates that some part of the work to be done has been started

func (*Bar) Finished

func (b *Bar) Finished(message ...any)

Finished indicates that the task being measured has finished completely

func (*Bar) Reset

func (b *Bar) Reset(opts ...opt)

func (*Bar) Start

func (b *Bar) Start()

func (*Bar) Todo

func (b *Bar) Todo(size int64)

Todo increases the amount of work to be done