README
¶
progress 
io.Reader and io.Writer with progress and remaining time estimation.
Usage
ctx := context.Background()
// get a reader and the total expected number of bytes
s := `Now that's what I call progress`
size := len(s)
r := progress.NewReader(strings.NewReader(s))
// Start a goroutine printing progress
go func() {
ctx := context.Background()
progressChan := progress.NewTicker(ctx, r, size, 1*time.Second)
for p := range progressChan {
fmt.Printf("\r%v remaining...", p.Remaining().Round(time.Second))
}
fmt.Println("\rdownload is completed")
}()
// use the Reader as normal
if _, err := io.Copy(dest, r); err != nil {
log.Fatalln(err)
}
- Wrap an
io.Readerorio.WriterwithNewReaderandNewWriterrespectively - Capture the total number of expected bytes
- Use
progress.NewTickerto get a channel on which progress updates will be sent - Start a Goroutine to periodically check the progress, and do something with it - like log it
- Use the readers and writers as normal
Documentation
¶
Overview ¶
Package progress provides io.Reader and io.Writer with progress and remaining time estimation.
ctx := context.Background()
// get a reader and the total expected number of bytes
s := `Now that's what I call progress`
size := len(s)
r := progress.NewReader(strings.NewReader(s))
// Start a goroutine printing progress
go func() {
ctx := context.Background()
progressChan := progress.NewTicker(ctx, r, size, 1*time.Second)
for p := range progressChan {
fmt.Printf("\r%v remaining...", p.Remaining().Round(time.Second))
}
fmt.Println("\rdownload is completed")
}()
// use the Reader as normal
if _, err := io.Copy(dest, r); err != nil {
log.Fatalln(err)
}
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewTicker ¶
NewTicker gets a channel on which ticks of Progress are sent at duration d intervals until the operation is complete at which point the channel is closed. The counter is either a Reader or Writer (or any type that can report its progress). The size is the total number of expected bytes being read or written. If the context cancels the operation, the channel is closed.
Types ¶
type Counter ¶
type Counter interface {
// N gets the current count value.
// For readers and writers, this is the number of bytes
// read or written.
// For other contexts, the number may be anything.
N() int64
// Err gets the last error from the Reader or Writer.
// When the process is finished, this will be io.EOF.
Err() error
}
Counter counts bytes. Both Reader and Writer are Counter types.
type Progress ¶
type Progress struct {
// contains filtered or unexported fields
}
Progress represents a moment of progress.
func (Progress) Complete ¶
Complete gets whether the operation is complete or not. Always returns false if the Size is unknown (-1).
func (Progress) Estimated ¶
Estimated gets the time at which the operation is expected to finish. Use Remaining to get a Duration. Estimated().IsZero() is true if no estimate is available.
func (Progress) N ¶
N gets the total number of bytes read or written so far.
func (Progress) Percent ¶
Percent calculates the percentage complete.
func (Progress) Remaining ¶
Remaining gets the amount of time until the operation is expected to be finished. Use Estimated to get a fixed completion time. Returns -1 if no estimate is available.
type Reader ¶
type Reader struct {
// contains filtered or unexported fields
}
Reader counts the bytes read through it.
func NewReader ¶
NewReader makes a new Reader that counts the bytes read through it.
func (*Reader) Err ¶ added in v0.2.0
Err gets the last error from the Reader.
func (*Reader) N ¶
N gets the number of bytes that have been read so far.
type Writer ¶
type Writer struct {
// contains filtered or unexported fields
}
Writer counts the bytes written through it.
func NewWriter ¶
NewWriter gets a Writer that counts the number of bytes written.
func (*Writer) Err ¶ added in v0.2.0
Err gets the last error from the Writer.
func (*Writer) N ¶
N gets the number of bytes that have been written so far.
Source Files
¶
- progress.go
- reader.go
- writer.go
Directories