/
bytes.go
150 lines (125 loc) · 3.54 KB
/
bytes.go
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
// Copyright (c) 2016 Uber Technologies, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
package checked
var (
defaultBytesOptions = NewBytesOptions()
)
// Bytes is a checked byte slice.
type Bytes interface {
ReadWriteRef
// Bytes returns an unchecked reference to the underlying bytes, callers
// should discard the reference immediately after use and the use of
// the reference must not extend past the lifetime of the checked bytes
// itself.
Bytes() []byte
// Cap returns capacity of the bytes.
Cap() int
// Len returns the length of the bytes.
Len() int
// Resize will resize the bytes slice, this allows for reuse of the already
// allocated bytes slices.
Resize(size int)
// Append will append a single byte to the bytes slice.
Append(value byte)
// AppendAll will append bytes to the bytes slice.
AppendAll(values []byte)
// Reset will reset the reference referred to by the bytes.
Reset(v []byte)
}
type bytesRef struct {
RefCount
opts BytesOptions
value []byte
}
// NewBytes returns a new checked byte slice.
func NewBytes(value []byte, opts BytesOptions) Bytes {
if opts == nil {
opts = defaultBytesOptions
}
b := &bytesRef{
opts: opts,
value: value,
}
b.SetOnFinalize(b)
// NB(r): Tracking objects causes interface allocation
// so avoid if we are not performing any leak detection.
if leakDetectionEnabled() {
b.TrackObject(b.value)
}
return b
}
func (b *bytesRef) Bytes() []byte {
b.IncReads()
v := b.value
b.DecReads()
return v
}
func (b *bytesRef) Cap() int {
b.IncReads()
v := cap(b.value)
b.DecReads()
return v
}
func (b *bytesRef) Len() int {
b.IncReads()
v := len(b.value)
b.DecReads()
return v
}
func (b *bytesRef) Resize(size int) {
b.IncWrites()
b.value = b.value[:size]
b.DecWrites()
}
func (b *bytesRef) Append(value byte) {
b.IncWrites()
b.value = append(b.value, value)
b.DecWrites()
}
func (b *bytesRef) AppendAll(values []byte) {
b.IncWrites()
b.value = append(b.value, values...)
b.DecWrites()
}
func (b *bytesRef) Reset(v []byte) {
b.IncWrites()
b.value = v
b.DecWrites()
}
func (b *bytesRef) OnFinalize() {
if finalizer := b.opts.Finalizer(); finalizer != nil {
finalizer.FinalizeBytes(b)
}
}
type bytesOptions struct {
finalizer BytesFinalizer
}
// NewBytesOptions returns a new set of bytes options.
func NewBytesOptions() BytesOptions {
return &bytesOptions{}
}
func (o *bytesOptions) Finalizer() BytesFinalizer {
return o.finalizer
}
func (o *bytesOptions) SetFinalizer(value BytesFinalizer) BytesOptions {
opts := *o
opts.finalizer = value
return &opts
}