progress

package

v3.0.2 Latest Latest Go to latest Published: Nov 28, 2022 License: MIT Imports: 3 Imported by: 0

Details

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.