summaryrefslogtreecommitdiff
path: root/vendor/github.com/dsoprea/go-utility/v2/filesystem/read_counter.go
blob: d878ca4e656fb0f71e90cdd3d3dd0196a8afd579 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
package rifs

import (
	"io"
)

// ReadCounter proxies read requests and maintains a counter of bytes read.
type ReadCounter struct {
	r       io.Reader
	counter int
}

// NewReadCounter returns a new `ReadCounter` struct wrapping a `Reader`.
func NewReadCounter(r io.Reader) *ReadCounter {
	return &ReadCounter{
		r: r,
	}
}

// Count returns the total number of bytes read.
func (rc *ReadCounter) Count() int {
	return rc.counter
}

// Reset resets the counter to zero.
func (rc *ReadCounter) Reset() {
	rc.counter = 0
}

// Read forwards a read to the underlying `Reader` while bumping the counter.
func (rc *ReadCounter) Read(b []byte) (n int, err error) {
	n, err = rc.r.Read(b)
	rc.counter += n

	return n, err
}