progress

Documentation

Index

• func Aux(out Output, a interface{})
• func Message(out Output, id, message string)
• func Messagef(out Output, id, format string, a ...interface{})
• func Update(out Output, id, action string)
• func Updatef(out Output, id, format string, a ...interface{})
• type Output
  • func ChanOutput(progressChan chan<- Progress) Output
  • func DiscardOutput() Output
• type Progress
• type Reader
  • func NewProgressReader(in io.ReadCloser, out Output, size int64, id, action string) *Reader
  • func (p *Reader) Close() error
  • func (p *Reader) Read(buf []byte) (n int, err error)
• type Sink
  • func NewProgressSink(out Output, size int64, id, action string) *Sink
  • func (p *Sink) Write(buf []byte) (int, error)

Functions

func Aux

func Aux(out Output, a interface{})

Aux sends auxiliary information over a progress interface, which will not be formatted for the UI. This is used for things such as push signing.

func Message

func Message(out Output, id, message string)

Message is a convenience function to write a progress message to the channel.

func Messagef

func Messagef(out Output, id, format string, a ...interface{})

Messagef is a convenience function to write a printf-formatted progress message to the channel.

func Update

func Update(out Output, id, action string)

Update is a convenience function to write a progress update to the channel.

func Updatef

func Updatef(out Output, id, format string, a ...interface{})

Updatef is a convenience function to write a printf-formatted progress update to the channel.

Types

type Output

type Output interface {
	WriteProgress(Progress) error
}

Output is an interface for writing progress information. It's like a writer for progress, but we don't call it Writer because that would be confusing next to ProgressReader (also, because it doesn't implement the io.Writer interface).

func ChanOutput

func ChanOutput(progressChan chan<- Progress) Output

ChanOutput returns an Output that writes progress updates to the supplied channel.

func DiscardOutput

func DiscardOutput() Output

DiscardOutput returns an Output that discards progress

type Progress

type Progress struct {
	ID string

	// Progress contains a Message or...
	Message string

	// ...progress of an action
	Action  string
	Current int64
	Total   int64

	// If true, don't show xB/yB
	HideCounts bool
	// If not empty, use units instead of bytes for counts
	Units string

	// Aux contains extra information not presented to the user, such as
	// digests for push signing.
	Aux interface{}

	LastUpdate bool
}

Progress represents the progress of a transfer.

type Reader

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

Reader is a Reader with progress bar.

func NewProgressReader

func NewProgressReader(in io.ReadCloser, out Output, size int64, id, action string) *Reader

NewProgressReader creates a new ProgressReader.

func (*Reader) Close

func (p *Reader) Close() error

Close closes the progress reader and its underlying reader.

func (*Reader) Read

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

type Sink

type Sink struct {
	sync.Mutex

	Size int64
	// contains filtered or unexported fields
}

func NewProgressSink

func NewProgressSink(out Output, size int64, id, action string) *Sink

NewProgressSink creates a new ProgressSink.

func (*Sink) Write

func (p *Sink) Write(buf []byte) (int, error)