progress

Documentation

Index

• func ToCtx(ctx context.Context, v Progress) context.Context
• type Mode
• type Option
  • func WithBytes(enabled bool) Option
  • func WithCleanOnFinish() Option
  • func WithDescription(desc string) Option
  • func WithElapsedTime(elapsed bool) Option
  • func WithIts() Option
  • func WithMax(m int64) Option
  • func WithOnComplete(f func()) Option
  • func WithPredictTime(predict bool) Option
  • func WithShowElapsedTime() Option
  • func WithSpinnerType(spinnerType int) Option
  • func WithTheme(t Theme) Option
  • func WithWidth(w int) Option
• type OptionFunc
  • func (o OptionFunc) Opt() progressbar.Option
• type Progress
  • func FromCtx(ctx context.Context) Progress
  • func Init(m Mode) (Progress, error)
  • func New(w io.Writer, options ...Option) Progress
  • func NopProgress() Progress
• type Theme

Functions

func ToCtx

func ToCtx(ctx context.Context, v Progress) context.Context

Types

type Mode

type Mode string

const (
	AutoMode Mode = "auto"
	NoMode   Mode = "no"
)

type Option

type Option interface {
	Opt() progressbar.Option
}

func WithBytes

func WithBytes(enabled bool) Option

func WithCleanOnFinish

func WithCleanOnFinish() Option

func WithDescription

func WithDescription(desc string) Option

func WithElapsedTime

func WithElapsedTime(elapsed bool) Option

func WithIts

func WithIts() Option

func WithMax

func WithMax(m int64) Option

func WithOnComplete

func WithOnComplete(f func()) Option

func WithPredictTime

func WithPredictTime(predict bool) Option

func WithShowElapsedTime

func WithShowElapsedTime() Option

func WithSpinnerType

func WithSpinnerType(spinnerType int) Option

func WithTheme

func WithTheme(t Theme) Option

func WithWidth

func WithWidth(w int) Option

type OptionFunc

type OptionFunc func() progressbar.Option

func (OptionFunc) Opt

func (o OptionFunc) Opt() progressbar.Option

type Progress

type Progress interface {
	io.Writer

	Add(delta int64)
	Inc()

	// Finish fills bar to full
	Finish()
	// Exit progress and leave progress at current state
	Exit()

	Alter(opts ...Option) Progress
}

func FromCtx

func FromCtx(ctx context.Context) Progress

func Init

func Init(m Mode) (Progress, error)

func New

func New(w io.Writer, options ...Option) Progress

func NopProgress

func NopProgress() Progress

type Theme

type Theme struct {
	Saucer        string
	AltSaucerHead string
	SaucerHead    string
	SaucerPadding string
	BarStart      string
	BarEnd        string
}