utils

Documentation

Overview

Package utils contains command functionality which is reused across multiple other packages.

Index

• Constants
• func Retry(f func() error) error
• type Progress
  • func NewProgress(bytesRead int64, bytesPerSecond int64, completed bool) *Progress
• type ProgressBar
  • func NewProgressBar(logger log.Logger) *ProgressBar
  • func (b *ProgressBar) Remove()
  • func (b *ProgressBar) Update(text string, current int64, total int64, bytesPerSecond int64)
• type ProgressReader
  • func NewProgressReader(reader io.Reader, progressFunc func(progress Progress)) *ProgressReader
  • func (r *ProgressReader) Read(p []byte) (n int, err error)
• type RetryableError
  • func Retryable(err error) *RetryableError
  • func (e RetryableError) Error() string

Constants

const MaxAttempts = 3

Functions

func Retry

func Retry(f func() error) error

Retries the given function up to 3 times when it returns an RetryableError.

Types

type Progress

type Progress struct {
	BytesRead      int64
	BytesPerSecond int64
	Completed      bool
}

The Progress structure contains statistics about how many bytes have been read from the underlying reader.

func NewProgress

func NewProgress(bytesRead int64, bytesPerSecond int64, completed bool) *Progress

type ProgressBar

type ProgressBar struct {
	Logger log.Logger
	// contains filtered or unexported fields
}

The ProgressBar helps rendering a text-based progress indicator on the command-line. It uses the standard error output interface of the logger for writing progress.

func NewProgressBar

func NewProgressBar(logger log.Logger) *ProgressBar

func (*ProgressBar) Remove

func (b *ProgressBar) Remove()

func (*ProgressBar) Update

func (b *ProgressBar) Update(text string, current int64, total int64, bytesPerSecond int64)

type ProgressReader

type ProgressReader struct {
	io.Reader
	ProgressFunc func(progress Progress)
	// contains filtered or unexported fields
}

The ProgressReader is a wrapper over the io.Reader interface which computes statistics while the data is read. This is used to show progress for file uploads and downloads.

The ProgressReader emits a Progress event whenever data is read from the reader. The event is debounced to avoid too many events.

func NewProgressReader

func NewProgressReader(reader io.Reader, progressFunc func(progress Progress)) *ProgressReader

func (*ProgressReader) Read

func (r *ProgressReader) Read(p []byte) (n int, err error)

type RetryableError

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

RetryableError can be returned inside of the Retry() block to indicate that the function failed and should be retried.

func Retryable

func Retryable(err error) *RetryableError

func (RetryableError) Error

func (e RetryableError) Error() string