metered

README

Metered io.Reader and io.Writer

A drop-in replacement to io.Reader and io.Writer from the standard library with the total number of bytes transfered.

🚀 Install

go get github.com/samber/go-metered-io

This library is v1 and follows SemVer strictly. No breaking changes will be made to exported APIs before v2.0.0.

💡 Spec

GoDoc: https://pkg.go.dev/github.com/samber/go-metered-io

Byte:

• metered.NewReader
• metered.NewWriter
• metered.NewReadCloser
• metered.NewWriteCloser
• metered.NewReadWriter

String:

• metered.NewStringWriter

Rune:

• metered.NewRuneReader

Examples

Metered reader

import "github.com/samber/go-metered-io"

r := metered.NewReader(strings.NewReader("Lorem ipsum dolor sit amet..."))

for {
    buff := make([]byte, 10)

    _, err := r.Read(buff)
    if err != nil {
        break
    }
}

fmt.Printf("Total bytes: %d", r.Rx())

Metered writer

import "github.com/samber/go-metered-io"

var buf bytes.Buffer
w := metered.NewWriter(&buf)

for i := 0 ; i < 10 ; i++ {
    _, err := w.Write("Hello world\n")
    if err != nil {
        break
    }
}

fmt.Printf("Total bytes: %d", w.Tx())

🤝 Contributing

• Ping me on twitter @samuelberthe (DMs, mentions, whatever :))
• Fork the project
• Fix open issues or request new features

Don't hesitate ;)

# Install some dev dependencies
make tools

# Run tests
make test
# or
make watch-test

👤 Contributors

💫 Show your support

Give a ⭐️ if this project helped you!

📝 License

Copyright © 2023 Samuel Berthe.

This project is MIT licensed.

Documentation

Index

• type ReadCloser
  • func NewReadCloser(r io.ReadCloser) *ReadCloser
• type ReadWriteCloser
  • func NewReadWriteCloser(rw io.ReadWriteCloser) *ReadWriteCloser
• type ReadWriter
  • func NewReadWriter(rw io.ReadWriter) *ReadWriter
  • func (rw *ReadWriter) Read(p []byte) (n int, err error)
  • func (rw *ReadWriter) Rx() uint64
  • func (rw *ReadWriter) Tx() uint64
  • func (rw *ReadWriter) Write(p []byte) (n int, err error)
• type Reader
  • func NewReader(reader io.Reader) *Reader
  • func (r *Reader) Read(p []byte) (n int, err error)
  • func (r *Reader) Rx() uint64
• type RuneReader
  • func NewRuneReader(rw io.RuneReader) *RuneReader
  • func (rw *RuneReader) ReadRune() (r rune, n int, err error)
  • func (rw *RuneReader) Tx() uint64
• type StringWriter
  • func NewStringWriter(sw io.StringWriter) *StringWriter
  • func (sw *StringWriter) Tx() uint64
  • func (sw *StringWriter) WriteString(p string) (n int, err error)
• type WriteCloser
  • func NewWriteCloser(w io.WriteCloser) *WriteCloser
• type Writer
  • func NewWriter(writer io.Writer) *Writer
  • func (w *Writer) Tx() uint64
  • func (w *Writer) Write(p []byte) (n int, err error)

Types

type ReadCloser

type ReadCloser struct {
	*Reader
	io.Closer
}

Implements io.ReadCloser

func NewReadCloser

func NewReadCloser(r io.ReadCloser) *ReadCloser

type ReadWriteCloser

type ReadWriteCloser struct {
	*ReadWriter
	io.Closer
}

Implements io.ReadWriteCloser

func NewReadWriteCloser

func NewReadWriteCloser(rw io.ReadWriteCloser) *ReadWriteCloser

type ReadWriter

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

Implements io.ReadWriter

func NewReadWriter

func NewReadWriter(rw io.ReadWriter) *ReadWriter

func (*ReadWriter) Read

func (rw *ReadWriter) Read(p []byte) (n int, err error)

func (*ReadWriter) Rx

func (rw *ReadWriter) Rx() uint64

func (*ReadWriter) Tx

func (rw *ReadWriter) Tx() uint64

func (*ReadWriter) Write

func (rw *ReadWriter) Write(p []byte) (n int, err error)

type Reader

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

Implements io.Reader

func NewReader

func NewReader(reader io.Reader) *Reader

func (*Reader) Read

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

func (*Reader) Rx

func (r *Reader) Rx() uint64

type RuneReader

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

Implements io.RuneWriter

func NewRuneReader

func NewRuneReader(rw io.RuneReader) *RuneReader

func (*RuneReader) ReadRune

func (rw *RuneReader) ReadRune() (r rune, n int, err error)

func (*RuneReader) Tx

func (rw *RuneReader) Tx() uint64

type StringWriter

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

Implements io.StringWriter

func NewStringWriter

func NewStringWriter(sw io.StringWriter) *StringWriter

func (*StringWriter) Tx

func (sw *StringWriter) Tx() uint64

func (*StringWriter) WriteString

func (sw *StringWriter) WriteString(p string) (n int, err error)

type WriteCloser

type WriteCloser struct {
	*Writer
	io.Closer
}

Implements io.WriterCloser

func NewWriteCloser

func NewWriteCloser(w io.WriteCloser) *WriteCloser

type Writer

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

Implements io.Writer

func NewWriter

func NewWriter(writer io.Writer) *Writer

func (*Writer) Tx

func (w *Writer) Tx() uint64

func (*Writer) Write

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