ioprogress

Documentation

Index

• type ProgressData
• type ProgressReader
  • func (pt *ProgressReader) Read(p []byte) (int, error)
• type ProgressTracker
• type ProgressWriter
  • func (pt *ProgressWriter) Write(p []byte) (int, error)

Types

type ProgressData

type ProgressData struct {
	// Preferred string representation of progress (always set)
	Text string

	// Progress in percent
	Percentage int

	// Number of bytes transferred (for files)
	TransferredBytes int64

	// Total number of bytes (for files)
	TotalBytes int64
}

The ProgressData struct represents new progress information on an operation.

type ProgressReader

type ProgressReader struct {
	io.Reader
	io.ReadCloser
	Tracker *ProgressTracker
}

ProgressReader is a wrapper around ReadCloser which allows for progress tracking.

func (*ProgressReader) Read

func (pt *ProgressReader) Read(p []byte) (int, error)

Read in ProgressReader is the same as io.Read.

type ProgressTracker

type ProgressTracker struct {
	Length  int64
	Handler func(int64, int64)
	// contains filtered or unexported fields
}

ProgressTracker provides the stream information needed for tracking.

type ProgressWriter

type ProgressWriter struct {
	io.WriteCloser
	Tracker *ProgressTracker
}

ProgressWriter is a wrapper around WriteCloser which allows for progress tracking.

func (*ProgressWriter) Write

func (pt *ProgressWriter) Write(p []byte) (int, error)

Write in ProgressWriter is the same as io.Write.