progress

package

Go to main page

Versions in this module

v1

v1.1.2

Jul 20, 2026

v1.1.1

Jul 16, 2026

v1.1.0

Jul 13, 2026

v1.0.10

Jul 13, 2026

v1.0.9

Jul 13, 2026

v1.0.8

Jul 12, 2026

v1.0.7

Jul 12, 2026

v1.0.6

Jul 12, 2026

v1.0.5

Jul 11, 2026

Changes in this version

+ func WithAutoWidth() func(*TextColumn)

type Progress

+ func (p *Progress) AddSection(opts ...SectionOption) *Section

+ type Section struct

+ func (s *Section) AddTask(description string, total *float64, opts ...TaskOption) TaskID

+ type SectionOption func(*Section)

+ func WithSectionColumns(cols ...Column) SectionOption

+ func WithSectionIndent(n int) SectionOption

type TextColumn

+ AutoWidth bool

v1.0.4

Jun 23, 2026

Changes in this version

type SpinnerColumn

+ func (sc *SpinnerColumn) Cleanup(id TaskID)

v1.0.3

Jun 23, 2026

Changes in this version

type Progress

+ func (p *Progress) Done(taskID TaskID, description ...string)

type Task

+ func (t *Task) Done(description ...string)

v1.0.2

Jun 22, 2026

Changes in this version

type DownloadColumn

+ Style *style.Style

type FileSizeColumn

+ Style *style.Style

type MofNCompleteColumn

+ Style *style.Style

type SpinnerColumn

+ FinishedStyle *style.Style

type TaskProgressColumn

+ Style *style.Style

type TimeElapsedColumn

+ Style *style.Style

type TimeRemainingColumn

+ Style *style.Style

type TotalFileSizeColumn

+ Style *style.Style

type TransferSpeedColumn

+ Style *style.Style

v1.0.1

Jun 4, 2026

v1.0.0

Apr 13, 2026

Changes in this version

+ var ErrNotSeekable = errors.New("reader does not support seeking")

+ func DefaultBarStyles() (back, complete, finished, pulse string)

+ func Track[T any](items []T, description string, opts ...Option) func(func(T) bool)

+ func WithBarWidth(width int) func(*BarColumn)

+ func WithFinishedText(text string) func(*SpinnerColumn)

+ func WithJustify(j console.Justify) func(*TextColumn)

+ func WithMarkup(enabled bool) func(*TextColumn)

+ func WithSpinnerName(name string) func(*SpinnerColumn)

+ func WithSpinnerStyle(s style.Style) func(*SpinnerColumn)

+ func WithTextStyle(s style.Style) func(*TextColumn)

+ func WithWidth(w int) func(*TextColumn)

+ type BarColumn struct

+ BarWidth *int

+ CompleteStyle string

+ FinishedStyle string

+ PulseStyle string

+ Style string

+ func NewBarColumn(opts ...func(*BarColumn)) *BarColumn

+ func (bc *BarColumn) MaxRefresh() time.Duration

+ func (bc *BarColumn) Render(task TaskSnapshot, c *console.Console, opts console.Options) []segment.Segment

+ type Column interface

+ MaxRefresh func() time.Duration

+ Render func(task TaskSnapshot, c *console.Console, opts console.Options) []segment.Segment

+ func DefaultColumns() []Column

+ type DownloadColumn struct

+ BinaryUnits bool

+ func NewDownloadColumn(binaryUnits bool) *DownloadColumn

+ func (dc *DownloadColumn) MaxRefresh() time.Duration

+ func (dc *DownloadColumn) Render(task TaskSnapshot, c *console.Console, opts console.Options) []segment.Segment

+ type FileSizeColumn struct

+ BinaryUnits bool

+ func NewFileSizeColumn(binaryUnits bool) *FileSizeColumn

+ func (fsc *FileSizeColumn) MaxRefresh() time.Duration

+ func (fsc *FileSizeColumn) Render(task TaskSnapshot, c *console.Console, opts console.Options) []segment.Segment

+ type MofNCompleteColumn struct

+ Separator string

+ func NewMofNCompleteColumn(separator string) *MofNCompleteColumn

+ func (mc *MofNCompleteColumn) MaxRefresh() time.Duration

+ func (mc *MofNCompleteColumn) Render(task TaskSnapshot, c *console.Console, opts console.Options) []segment.Segment

+ type Option func(*Progress)

+ func WithColumns(columns ...Column) Option

+ func WithConsole(c *console.Console) Option

+ func WithDisable(disable bool) Option

+ func WithExpand(expand bool) Option

+ func WithRefreshRate(hz float64) Option

+ func WithSpeedEstimatePeriod(seconds float64) Option

+ func WithTransient(transient bool) Option

+ type Progress struct

+ func New(opts ...Option) *Progress

+ func (p *Progress) AddTask(description string, total *float64, opts ...TaskOption) TaskID

+ func (p *Progress) Advance(taskID TaskID, amount float64)

+ func (p *Progress) Copy(dst io.Writer, src io.Reader, total int64, description string) (int64, error)

+ func (p *Progress) CopyBuffer(dst io.Writer, src io.Reader, buf []byte, total int64, description string) (int64, error)

+ func (p *Progress) Finished() bool

+ func (p *Progress) Refresh()

+ func (p *Progress) RemoveTask(taskID TaskID)

+ func (p *Progress) ResetTask(taskID TaskID, start bool)

+ func (p *Progress) Start(ctx context.Context)

+ func (p *Progress) StartTask(taskID TaskID)

+ func (p *Progress) Stop()

+ func (p *Progress) StopTask(taskID TaskID)

+ func (p *Progress) String() string

+ func (p *Progress) Update(taskID TaskID, cfg TaskUpdateConfig)

+ func (p *Progress) WrapFile(path string, description string) (*Reader, TaskID, error)

+ func (p *Progress) WrapReadCloser(rc io.ReadCloser, total int64, description string) (*ReadCloser, TaskID)

+ func (p *Progress) WrapReader(r io.Reader, total int64, description string) (*Reader, TaskID)

+ func (p *Progress) WrapWriter(w io.Writer, total int64, description string) (*Writer, TaskID)

+ type ProgressBar struct

+ ASCIIOnly bool

+ AnimationTime float64

+ BackStyle string

+ CompleteStyle string

+ Completed float64

+ Finished bool

+ FinishedStyle string

+ Pulse bool

+ PulseStyle string

+ Total *float64

+ Width *int

+ func (pb *ProgressBar) Measure(c *console.Console, opts console.Options) console.Measurement

+ func (pb *ProgressBar) Render(c *console.Console, opts console.Options) []segment.Segment

+ type ReadCloser struct

+ func NewReadCloser(rc io.ReadCloser, p *Progress, taskID TaskID) *ReadCloser

+ func (rc *ReadCloser) Close() error

+ type Reader struct

+ func NewReader(r io.Reader, p *Progress, taskID TaskID) *Reader

+ func (r *Reader) BytesRead() int64

+ func (r *Reader) Close() error

+ func (r *Reader) Read(p []byte) (n int, err error)

+ func (r *Reader) Seek(offset int64, whence int) (int64, error)

+ type RenderableColumn struct

+ Renderable console.Renderable

+ func NewRenderableColumn(r console.Renderable) *RenderableColumn

+ func (rc *RenderableColumn) MaxRefresh() time.Duration

+ func (rc *RenderableColumn) Render(task TaskSnapshot, c *console.Console, opts console.Options) []segment.Segment

+ type SeparatorColumn struct

+ Style *style.Style

+ Text string

+ func NewSeparatorColumn(text string) *SeparatorColumn

+ func (sc *SeparatorColumn) MaxRefresh() time.Duration

+ func (sc *SeparatorColumn) Render(task TaskSnapshot, c *console.Console, opts console.Options) []segment.Segment

+ type SpinnerColumn struct

+ FinishedText string

+ Speed float64

+ SpinnerName string

+ Style *style.Style

+ func NewSpinnerColumn(opts ...func(*SpinnerColumn)) *SpinnerColumn

+ func (sc *SpinnerColumn) MaxRefresh() time.Duration

+ func (sc *SpinnerColumn) Render(task TaskSnapshot, c *console.Console, opts console.Options) []segment.Segment

+ func (sc *SpinnerColumn) SetTaskSpinner(id TaskID, name string)

+ type Task struct

+ func NewTask(id TaskID, cfg TaskConfig, getTime func() float64, speedPeriod float64) *Task

+ func (t *Task) Advance(amount float64)

+ func (t *Task) ID() TaskID

+ func (t *Task) Reset(start bool)

+ func (t *Task) Snapshot() TaskSnapshot

+ func (t *Task) Start()

+ func (t *Task) Stop()

+ func (t *Task) Update(cfg TaskUpdateConfig)

+ type TaskConfig struct

+ Completed float64

+ Description string

+ Fields map[string]any

+ Start bool

+ Total *float64

+ Visible bool

+ type TaskID int64

+ type TaskOption func(*TaskConfig)

+ func TaskWithCompleted(completed float64) TaskOption

+ func TaskWithFields(fields map[string]any) TaskOption

+ func TaskWithStart(start bool) TaskOption

+ func TaskWithVisible(visible bool) TaskOption

+ type TaskProgressColumn struct

+ ShowSpeed bool

+ func NewTaskProgressColumn(showSpeed bool) *TaskProgressColumn

+ func (tpc *TaskProgressColumn) MaxRefresh() time.Duration

+ func (tpc *TaskProgressColumn) Render(task TaskSnapshot, c *console.Console, opts console.Options) []segment.Segment

+ type TaskSnapshot struct

+ Completed float64

+ CurrentTime float64

+ Description string

+ Elapsed *float64

+ Fields map[string]any

+ Finished bool

+ FinishedSpeed *float64

+ FinishedTime *float64

+ ID TaskID

+ Percentage float64

+ Speed *float64

+ Started bool

+ TimeRemaining *float64

+ Total *float64

+ Visible bool

+ func (s TaskSnapshot) GetSpeed() *float64

+ func (s TaskSnapshot) Remaining() *float64

+ type TaskUpdateConfig struct

+ Advance *float64

+ Completed *float64

+ Description *string

+ Fields map[string]any

+ Total *float64

+ Visible *bool

+ type TextColumn struct

+ Justify console.Justify

+ Markup bool

+ NoWrap bool

+ Style *style.Style

+ Text string

+ Width int

+ func DescriptionColumn(opts ...func(*TextColumn)) *TextColumn

+ func NewTextColumn(text string, opts ...func(*TextColumn)) *TextColumn

+ func (tc *TextColumn) MaxRefresh() time.Duration

+ func (tc *TextColumn) Render(task TaskSnapshot, c *console.Console, opts console.Options) []segment.Segment

+ type TimeElapsedColumn struct

+ Compact bool

+ func NewTimeElapsedColumn() *TimeElapsedColumn

+ func (tec *TimeElapsedColumn) MaxRefresh() time.Duration

+ func (tec *TimeElapsedColumn) Render(task TaskSnapshot, c *console.Console, opts console.Options) []segment.Segment

+ type TimeRemainingColumn struct

+ Compact bool

+ ElapsedWhenFinished bool

+ func NewTimeRemainingColumn() *TimeRemainingColumn

+ func (trc *TimeRemainingColumn) MaxRefresh() time.Duration

+ func (trc *TimeRemainingColumn) Render(task TaskSnapshot, c *console.Console, opts console.Options) []segment.Segment

+ type TotalFileSizeColumn struct

+ BinaryUnits bool

+ func NewTotalFileSizeColumn(binaryUnits bool) *TotalFileSizeColumn

+ func (tfsc *TotalFileSizeColumn) MaxRefresh() time.Duration

+ func (tfsc *TotalFileSizeColumn) Render(task TaskSnapshot, c *console.Console, opts console.Options) []segment.Segment

+ type TransferSpeedColumn struct

+ BinaryUnits bool

+ func NewTransferSpeedColumn(binaryUnits bool) *TransferSpeedColumn

+ func (tsc *TransferSpeedColumn) MaxRefresh() time.Duration

+ func (tsc *TransferSpeedColumn) Render(task TaskSnapshot, c *console.Console, opts console.Options) []segment.Segment

+ type Writer struct

+ func NewWriter(w io.Writer, p *Progress, taskID TaskID) *Writer

+ func (w *Writer) BytesWritten() int64

+ func (w *Writer) Close() error

+ func (w *Writer) Write(p []byte) (n int, err error)

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