File: lazy.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 (165 lines) | stat: -rw-r--r-- 3,862 bytes parent folder | download | duplicates (2)
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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
// 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 (
	"fmt"
	"io"
	"os"
)

// ReadOneByte reads one byte from given io.ReaderAt.
func ReadOneByte(r io.ReaderAt) error {
	buf := make([]byte, 1)
	n, err := r.ReadAt(buf, 0)
	if err != nil {
		return err
	}
	if n != 1 {
		return fmt.Errorf("expected to read 1 byte, but got %d", n)
	}
	return nil
}

// LazyOpener is a lazy io.Reader.
//
// LazyOpener will use a given open function to derive an io.Reader when Read
// is first called on the LazyOpener.
type LazyOpener struct {
	r    io.Reader
	s    string
	err  error
	open func() (io.Reader, error)
}

// NewLazyOpener returns a lazy io.Reader based on `open`.
func NewLazyOpener(filename string, open func() (io.Reader, error)) *LazyOpener {
	if len(filename) == 0 {
		return nil
	}
	return &LazyOpener{s: filename, open: open}
}

// Read implements io.Reader.Read lazily.
//
// If called for the first time, the underlying reader will be obtained and
// then used for the first and subsequent calls to Read.
func (lr *LazyOpener) Read(p []byte) (int, error) {
	if lr.r == nil && lr.err == nil {
		lr.r, lr.err = lr.open()
	}
	if lr.err != nil {
		return 0, lr.err
	}
	return lr.r.Read(p)
}

// String implements fmt.Stringer.
func (lr *LazyOpener) String() string {
	if len(lr.s) > 0 {
		return lr.s
	}
	if lr.r != nil {
		return fmt.Sprintf("%v", lr.r)
	}
	return "unopened mystery file"
}

// Close implements io.Closer.Close.
func (lr *LazyOpener) Close() error {
	if c, ok := lr.r.(io.Closer); ok {
		return c.Close()
	}
	return nil
}

// LazyOpenerAt is a lazy io.ReaderAt.
//
// LazyOpenerAt will use a given open function to derive an io.ReaderAt when
// ReadAt is first called.
type LazyOpenerAt struct {
	r     io.ReaderAt
	s     string
	err   error
	limit int64
	open  func() (io.ReaderAt, error)
}

// NewLazyFile returns a lazy ReaderAt opened from path.
func NewLazyFile(path string) *LazyOpenerAt {
	if len(path) == 0 {
		return nil
	}
	return NewLazyOpenerAt(path, func() (io.ReaderAt, error) {
		return os.Open(path)
	})
}

// NewLazyLimitFile returns a lazy ReaderAt opened from path with a limit reader on it.
func NewLazyLimitFile(path string, limit int64) *LazyOpenerAt {
	if len(path) == 0 {
		return nil
	}
	return NewLazyLimitOpenerAt(path, limit, func() (io.ReaderAt, error) {
		return os.Open(path)
	})
}

// NewLazyOpenerAt returns a lazy io.ReaderAt based on `open`.
func NewLazyOpenerAt(filename string, open func() (io.ReaderAt, error)) *LazyOpenerAt {
	return &LazyOpenerAt{s: filename, open: open, limit: -1}
}

// NewLazyLimitOpenerAt returns a lazy io.ReaderAt based on `open`.
func NewLazyLimitOpenerAt(filename string, limit int64, open func() (io.ReaderAt, error)) *LazyOpenerAt {
	return &LazyOpenerAt{s: filename, open: open, limit: limit}
}

// String implements fmt.Stringer.
func (loa *LazyOpenerAt) String() string {
	if len(loa.s) > 0 {
		return loa.s
	}
	if loa.r != nil {
		return fmt.Sprintf("%v", loa.r)
	}
	return "unopened mystery file"
}

// File returns the backend file of the io.ReaderAt if it
// is backed by a os.File.
func (loa *LazyOpenerAt) File() *os.File {
	if f, ok := loa.r.(*os.File); ok {
		return f
	}
	return nil
}

// ReadAt implements io.ReaderAt.ReadAt.
func (loa *LazyOpenerAt) ReadAt(p []byte, off int64) (int, error) {
	if loa.r == nil && loa.err == nil {
		loa.r, loa.err = loa.open()
	}
	if loa.err != nil {
		return 0, loa.err
	}
	if loa.limit > 0 {
		if off >= loa.limit {
			return 0, io.EOF
		}
		if int64(len(p)) > loa.limit-off {
			p = p[0 : loa.limit-off]
		}
	}
	return loa.r.ReadAt(p, off)
}

// Close implements io.Closer.Close.
func (loa *LazyOpenerAt) Close() error {
	if c, ok := loa.r.(io.Closer); ok {
		return c.Close()
	}
	return nil
}