progress_report

package

v0.33.3 Latest Latest Go to latest Published: Jan 23, 2025 License: GPL-3.0 Imports: 4 Imported by: 2

Details

View Source

const (
	UnitsNone = iota
	UnitsBytes
)

View Source

var ErrorProgressDone = errors.New("Progress is done")

Not a real error, just a flag that can be used to tell progress reporter that this process is Done

func NewBytesReporterContext(
	ctx context.Context,
	reporter *BytesReporter,
) context.Context

func NewContext(ctx context.Context, updateFunc ReportProgress) context.Context

Insert a progress reporting function in the context

This serves kind of like an interface, as the implementation of what to do when progress is reported is done by the caller

func NewReporterReader(parent io.Reader, reportProgress ReportRead) *reporterReader

Wraps an io.Reader in another Reader which reports the amount of bytes read anytime the parent is read

func NewReporterWriter(parent io.Writer, reportProgress ReportWrite) *reporterWriter

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

func BytesReporterFromContext(ctx context.Context) *BytesReporter

func NewBytesReporter(
	ctx context.Context,
	name string,
	size uint64,
) *BytesReporter

func (r *BytesReporter) End()

func (r *BytesReporter) Report(bytes uint64, err error)

Report the amount of new bytes progressed, if any, and an error, if any. Nil-pointer safe

func (r *BytesReporter) Start()

type ReportProgress func(msg string, done, total uint64, units Units, reportErr error)

Progress reporting function signature

func FromContext(ctx context.Context) ReportProgress

Retrieves the progress reporting function from the context

type ReportRead func(n uint64, err error)

type ReportWrite func(n uint64, err error)

type Units int

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

func NewUnitsReporter(
	ctx context.Context,
	name string,
	total uint64,
) *UnitsReporter

func (r *UnitsReporter) End()

func (r *UnitsReporter) Report(units uint64, total uint64, err error)

Report the amount of new units progressed, if any, an update to the total value, if any, and an error, if any. Nil-pointer safe

func (r *UnitsReporter) Start()