Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
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 Messagef ¶
Messagef is a convenience function to write a printf-formatted progress message to the channel.
Types ¶
type Output ¶
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 ¶
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.
Source Files
Click to show internal directories.
Click to hide internal directories.