File: cached.go

package info (click to toggle)
golang-github-u-root-uio 0.0~git20240224.d2acac8-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 276 kB
  • sloc: sh: 25; makefile: 2
file content (98 lines) | stat: -rw-r--r-- 2,168 bytes parent folder | download | duplicates (5)
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
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
// Copyright 2018 the u-root Authors. All rights reserved
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.

package uio

import (
	"bytes"
	"io"
)

// CachingReader is a lazily caching wrapper of an io.Reader.
//
// The wrapped io.Reader is only read from on demand, not upfront.
type CachingReader struct {
	buf bytes.Buffer
	r   io.Reader
	pos int
	eof bool
}

// NewCachingReader buffers reads from r.
//
// r is only read from when Read() is called.
func NewCachingReader(r io.Reader) *CachingReader {
	return &CachingReader{
		r: r,
	}
}

func (cr *CachingReader) read(p []byte) (int, error) {
	n, err := cr.r.Read(p)
	cr.buf.Write(p[:n])
	if err == io.EOF || (n == 0 && err == nil) {
		cr.eof = true
		return n, io.EOF
	}
	return n, err
}

// NewReader returns a new io.Reader that reads cr from offset 0.
func (cr *CachingReader) NewReader() io.Reader {
	return Reader(cr)
}

// Read reads from cr; implementing io.Reader.
//
// TODO(chrisko): Decide whether to keep this or only keep NewReader().
func (cr *CachingReader) Read(p []byte) (int, error) {
	n, err := cr.ReadAt(p, int64(cr.pos))
	cr.pos += n
	return n, err
}

// ReadAt reads from cr; implementing io.ReaderAt.
func (cr *CachingReader) ReadAt(p []byte, off int64) (int, error) {
	if len(p) == 0 {
		return 0, nil
	}
	end := int(off) + len(p)

	// Is the caller asking for some uncached bytes?
	unread := end - cr.buf.Len()
	if unread > 0 {
		// Avoiding allocations: use `p` to read more bytes.
		for unread > 0 {
			toRead := unread % len(p)
			if toRead == 0 {
				toRead = len(p)
			}

			m, err := cr.read(p[:toRead])
			unread -= m
			if err == io.EOF {
				break
			}
			if err != nil {
				return 0, err
			}
		}
	}

	// If this is true, the entire file was read just to find out, but the
	// offset is beyond the end of the file.
	if off > int64(cr.buf.Len()) {
		return 0, io.EOF
	}

	var err error
	// Did the caller ask for more than was available?
	//
	// Note that any io.ReaderAt implementation *must* return an error for
	// short reads.
	if cr.eof && unread > 0 {
		err = io.EOF
	}
	return copy(p, cr.buf.Bytes()[off:]), err
}