throttle

Documentation

Index

• type ThrottledWriter
  • func NewThrottleWriter(w io.Writer, speed, minWrite int64) *ThrottledWriter
  • func (tw *ThrottledWriter) ReadFrom(r io.Reader) (n int64, err error)
  • func (tw *ThrottledWriter) Write(b []byte) (n int, err error)

Types

type ThrottledWriter

type ThrottledWriter struct {
	io.Writer
	// contains filtered or unexported fields
}

ThrottledWriter is a writer that throttles what it writes it also implements io.ReaderFrom

func NewThrottleWriter

func NewThrottleWriter(w io.Writer, speed, minWrite int64) *ThrottledWriter

NewThrottleWriter creates a new throttledWriter writing in the provided io.Writer speed is the desired speed, while min and max Writes is the minimum or max writes that will be made at a time to the underlying writer. Notice: if minWrite is bigger than speed it will become equal to it.

func (*ThrottledWriter) ReadFrom

func (tw *ThrottledWriter) ReadFrom(r io.Reader) (n int64, err error)

ReadFrom reads from the provided io.Reader while respecting the throttling

func (*ThrottledWriter) Write

func (tw *ThrottledWriter) Write(b []byte) (n int, err error)