terminal

Documentation

Index

• type NoOpProgress
  • func (NoOpProgress) FileHook(os.FileInfo, transfer.FileOperation, *uint64, error)
  • func (NoOpProgress) FinishUpload(Upload)
  • func (NoOpProgress) RunUpload(context.Context, Upload)
• type Progress
  • func NewProgress(w io.Writer, period time.Duration) Progress
• type Upload

Types

type NoOpProgress

type NoOpProgress struct{}

A NoOpProgress doesn't report progress to a terminal.

func (NoOpProgress) FileHook

func (NoOpProgress) FileHook(os.FileInfo, transfer.FileOperation, *uint64, error)

func (NoOpProgress) FinishUpload

func (NoOpProgress) FinishUpload(Upload)

func (NoOpProgress) RunUpload

func (NoOpProgress) RunUpload(context.Context, Upload)

type Progress

type Progress interface {
	FileHook(os.FileInfo, transfer.FileOperation, *uint64, error)
	RunUpload(context.Context, Upload)
	FinishUpload(Upload)
}

func NewProgress

func NewProgress(w io.Writer, period time.Duration) Progress

NewProgress creates a new progress reporter. If the writer is not a terminal, progress reporting is disabled.

type Upload

type Upload interface {
	Stats() transfer.UploadStats
}