progress

package

v3.1.0 Latest Latest Go to latest Published: Oct 22, 2023 License: MIT Imports: 3 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

This section is empty.

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

Reader is an io.Reader for checking progress.

func NewReader(rd io.Reader, total, current int64) *Reader

NewReader create a new io.Reader for checking progress.

func (r *Reader) Current() int64

func (r *Reader) Err() error

Err returns err.

func (r *Reader) Finish(err error)

Finish finishes the progress check operation.

func (r *Reader) Finished() <-chan struct{}

Finish sends notification when finished any progress.

func (r *Reader) FractionCompleted() float64

FractionCompleted returns the fraction of the overall work completed by this progress struct, including work done by any children it may have.

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

Read reads data using underlying io.Reader. The number of bytes read is added to the current progress status.