passthru

Documentation

Overview

Package passthru provides Reader and Writer with information about the amount of data being passed.

Example

Index

• Variables
• type Calculator
  • func NewCalculator(total int64, winSizeSec float64) *Calculator
  • func (c *Calculator) Calculate(current int64) (float64, time.Duration)
  • func (c *Calculator) SetTotal(total int64)
• type Reader
  • func NewReader(reader io.ReadCloser, total int64) *Reader
  • func (r *Reader) Close() error
  • func (r *Reader) Current() int64
  • func (r *Reader) IsClosed() bool
  • func (r *Reader) Progress() float64
  • func (r *Reader) Read(p []byte) (int, error)
  • func (r *Reader) SetTotal(total int64)
  • func (r *Reader) Speed() (float64, time.Duration)
  • func (r *Reader) Total() int64
• type Writer
  • func NewWriter(writer io.WriteCloser, total int64) *Writer
  • func (w *Writer) Close() error
  • func (w *Writer) Current() int64
  • func (w *Writer) IsClosed() bool
  • func (w *Writer) Progress() float64
  • func (w *Writer) SetTotal(total int64)
  • func (w *Writer) Speed() (float64, time.Duration)
  • func (w *Writer) Total() int64
  • func (w *Writer) Write(p []byte) (int, error)

Examples

• Package

Variables

var (
	ErrNilReader = errors.New("Reader is nil")
	ErrNilWriter = errors.New("Writer is nil")
)

Types

type Calculator

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

Calculator calculates pass-thru speed and remaining time

func NewCalculator

func NewCalculator(total int64, winSizeSec float64) *Calculator

NewCalculator creates new Calculator struct

func (*Calculator) Calculate

func (c *Calculator) Calculate(current int64) (float64, time.Duration)

Calculate calculates speed and remaining time

func (*Calculator) SetTotal

func (c *Calculator) SetTotal(total int64)

SetTotal sets total number of objects

type Reader

type Reader struct {
	Calculator *Calculator
	Update     func(n int)
	// contains filtered or unexported fields
}

Reader is pass-thru Reader

func NewReader

func NewReader(reader io.ReadCloser, total int64) *Reader

NewReader creates new passthru reader

func (*Reader) Close

func (r *Reader) Close() error

Close closes the reader

func (*Reader) Current

func (r *Reader) Current() int64

Current returns read amount of data

func (*Reader) IsClosed

func (r *Reader) IsClosed() bool

IsClosed returns true if reader is closed

func (*Reader) Progress

func (r *Reader) Progress() float64

Progress returns percentage of data read

func (*Reader) Read

func (r *Reader) Read(p []byte) (int, error)

Read implements the standard Read interface

func (*Reader) SetTotal

func (r *Reader) SetTotal(total int64)

SetTotal sets total amount of data

func (*Reader) Speed

func (r *Reader) Speed() (float64, time.Duration)

Speed calculates passthru speed and time remaining to process all data. If Calculator was not set on the first call, a default calculator with a 10 second window is created.

func (*Reader) Total

func (r *Reader) Total() int64

Total returns total amount of data

type Writer

type Writer struct {
	Calculator *Calculator
	Update     func(n int)
	// contains filtered or unexported fields
}

Writer is pass-thru Writer

func NewWriter

func NewWriter(writer io.WriteCloser, total int64) *Writer

NewWriter creates new passthru writer

func (*Writer) Close

func (w *Writer) Close() error

Close closes the writer

func (*Writer) Current

func (w *Writer) Current() int64

Current returns written amount of data

func (*Writer) IsClosed

func (w *Writer) IsClosed() bool

IsClosed returns true if writer is closed

func (*Writer) Progress

func (w *Writer) Progress() float64

Progress returns percentage of data written

func (*Writer) SetTotal

func (w *Writer) SetTotal(total int64)

SetTotal sets total amount of data

func (*Writer) Speed

func (w *Writer) Speed() (float64, time.Duration)

Speed calculates passthru speed and time remaining to process all data. If Calculator was not set on the first call, a default calculator with a 10 second window is created.

func (*Writer) Total

func (w *Writer) Total() int64

Total returns total amount of data

func (*Writer) Write

func (w *Writer) Write(p []byte) (int, error)

Write implements the standard Write interface