Skip to content

Commit 6c7e606

Browse files
prestonvasquezprestonvasquez
committed
Rename bufferedValueReader to bufferedByteSrc
1 parent e321e55 commit 6c7e606

File tree

4 files changed

+38
-38
lines changed

4 files changed

+38
-38
lines changed

bson/buffered_value_reader.go renamed to bson/buffered_byte_src.go

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -11,19 +11,19 @@ import (
1111
"io"
1212
)
1313

14-
// bufferedValueReader implements the low-level byteSrc interface by reading
14+
// bufferedByteSrc implements the low-level byteSrc interface by reading
1515
// directly from an in-memory byte slice. It provides efficient, zero-copy
1616
// access for parsing BSON when the entire document is buffered in memory.
17-
type bufferedValueReader struct {
17+
type bufferedByteSrc struct {
1818
buf []byte // entire BSON document
1919
offset int64 // Current read index into buf
2020
}
2121

22-
var _ valueReaderByteSrc = (*bufferedValueReader)(nil)
22+
var _ valueReaderByteSrc = (*bufferedByteSrc)(nil)
2323

2424
// Read reads up to len(p) bytes from the in-memory buffer, advancing the offset
2525
// by the number of bytes read.
26-
func (b *bufferedValueReader) readExact(p []byte) (int, error) {
26+
func (b *bufferedByteSrc) readExact(p []byte) (int, error) {
2727
if b.offset >= int64(len(b.buf)) {
2828
return 0, io.EOF
2929
}
@@ -33,7 +33,7 @@ func (b *bufferedValueReader) readExact(p []byte) (int, error) {
3333
}
3434

3535
// ReadByte returns the single byte at buf[offset] and advances offset by 1.
36-
func (b *bufferedValueReader) ReadByte() (byte, error) {
36+
func (b *bufferedByteSrc) ReadByte() (byte, error) {
3737
if b.offset >= int64(len(b.buf)) {
3838
return 0, io.EOF
3939
}
@@ -42,7 +42,7 @@ func (b *bufferedValueReader) ReadByte() (byte, error) {
4242
}
4343

4444
// peek returns buf[offset:offset+n] without advancing offset.
45-
func (b *bufferedValueReader) peek(n int) ([]byte, error) {
45+
func (b *bufferedByteSrc) peek(n int) ([]byte, error) {
4646
// Ensure we don't read past the end of the buffer.
4747
if int64(n)+b.offset > int64(len(b.buf)) {
4848
return b.buf[b.offset:], io.EOF
@@ -53,7 +53,7 @@ func (b *bufferedValueReader) peek(n int) ([]byte, error) {
5353
}
5454

5555
// discard advances offset by n bytes, returning the number of bytes discarded.
56-
func (b *bufferedValueReader) discard(n int) (int, error) {
56+
func (b *bufferedByteSrc) discard(n int) (int, error) {
5757
// Ensure we don't read past the end of the buffer.
5858
if int64(n)+b.offset > int64(len(b.buf)) {
5959
// If we have exceeded the buffer length, discard only up to the end.
@@ -70,7 +70,7 @@ func (b *bufferedValueReader) discard(n int) (int, error) {
7070

7171
// readSlice scans buf[offset:] for the first occurrence of delim, returns
7272
// buf[offset:idx+1], and advances offset past it; errors if delim not found.
73-
func (b *bufferedValueReader) readSlice(delim byte) ([]byte, error) {
73+
func (b *bufferedByteSrc) readSlice(delim byte) ([]byte, error) {
7474
// Ensure we don't read past the end of the buffer.
7575
if b.offset >= int64(len(b.buf)) {
7676
return nil, io.EOF
@@ -93,12 +93,12 @@ func (b *bufferedValueReader) readSlice(delim byte) ([]byte, error) {
9393
}
9494

9595
// pos returns the current read position in the buffer.
96-
func (b *bufferedValueReader) pos() int64 {
96+
func (b *bufferedByteSrc) pos() int64 {
9797
return b.offset
9898
}
9999

100100
// regexLength will return the total byte length of a BSON regex value.
101-
func (b *bufferedValueReader) regexLength() (int32, error) {
101+
func (b *bufferedByteSrc) regexLength() (int32, error) {
102102
rem := b.buf[b.offset:]
103103

104104
// Find end of the first C-string (pattern).
@@ -118,11 +118,11 @@ func (b *bufferedValueReader) regexLength() (int32, error) {
118118
return int32(i + j + 2), nil
119119
}
120120

121-
func (*bufferedValueReader) streamable() bool {
121+
func (*bufferedByteSrc) streamable() bool {
122122
return false
123123
}
124124

125-
func (b *bufferedValueReader) reset() {
125+
func (b *bufferedByteSrc) reset() {
126126
b.buf = nil
127127
b.offset = 0
128128
}

bson/buffered_value_reader_test.go renamed to bson/buffered_byte_src_test.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ func TestBufferedvalueReader_discard(t *testing.T) {
6868

6969
for _, tt := range tests {
7070
t.Run(tt.name, func(t *testing.T) {
71-
reader := &bufferedValueReader{buf: tt.buf, offset: 0}
71+
reader := &bufferedByteSrc{buf: tt.buf, offset: 0}
7272
n, err := reader.discard(tt.n)
7373
if tt.wantErr != nil {
7474
assert.ErrorIs(t, err, tt.wantErr, "Expected error %v, got %v", tt.wantErr, err)
@@ -138,7 +138,7 @@ func TestBufferedvalueReader_peek(t *testing.T) {
138138

139139
for _, tt := range tests {
140140
t.Run(tt.name, func(t *testing.T) {
141-
reader := &bufferedValueReader{buf: tt.buf, offset: tt.offset}
141+
reader := &bufferedByteSrc{buf: tt.buf, offset: tt.offset}
142142
n, err := reader.peek(tt.n)
143143
if tt.wantErr != nil {
144144
assert.ErrorIs(t, err, tt.wantErr, "Expected error %v, got %v", tt.wantErr, err)

‎bson/value_reader.go‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -127,9 +127,9 @@ func newBufferedValueReader(t Type, b []byte) ValueReader {
127127
func newBufferedDocumentReader(b []byte) *valueReader {
128128
vr := vrPool.Get().(*valueReader)
129129

130-
vr.src = &bufferedValueReader{}
131-
vr.src.(*bufferedValueReader).buf = b
132-
vr.src.(*bufferedValueReader).offset = 0
130+
vr.src = &bufferedByteSrc{}
131+
vr.src.(*bufferedByteSrc).buf = b
132+
vr.src.(*bufferedByteSrc).offset = 0
133133

134134
// Reset parse state.
135135
vr.frame = 0

‎bson/value_reader_test.go‎

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ func TestValueReader_ReadBinary(t *testing.T) {
8181
t.Run(tc.name, func(t *testing.T) {
8282
t.Run("buffered", func(t *testing.T) {
8383
vr := &valueReader{
84-
src: &bufferedValueReader{buf: tc.data},
84+
src: &bufferedByteSrc{buf: tc.data},
8585
stack: []vrState{
8686
{mode: mTopLevel},
8787
{
@@ -174,7 +174,7 @@ func TestValueReader_ReadBoolean(t *testing.T) {
174174
t.Run(tc.name, func(t *testing.T) {
175175
t.Run("buffered", func(t *testing.T) {
176176
vr := &valueReader{
177-
src: &bufferedValueReader{buf: tc.data},
177+
src: &bufferedByteSrc{buf: tc.data},
178178
stack: []vrState{
179179
{mode: mTopLevel},
180180
{
@@ -222,7 +222,7 @@ func TestValueReader_ReadBoolean(t *testing.T) {
222222
func TestValueReader_ReadDocument_TopLevel_InvalidLength(t *testing.T) {
223223
t.Run("buffered", func(t *testing.T) {
224224
vr := &valueReader{
225-
src: &bufferedValueReader{buf: []byte{0x00, 0x00}},
225+
src: &bufferedByteSrc{buf: []byte{0x00, 0x00}},
226226
stack: []vrState{{mode: mTopLevel}},
227227
frame: 0,
228228
}
@@ -256,7 +256,7 @@ func TestValueReader_ReadDocument_TopLevel_InvalidLength(t *testing.T) {
256256
func TestValueReader_ReadDocument_TopLevel_ValidDocumentWithIncorrectEnd(t *testing.T) {
257257
t.Run("buffered", func(t *testing.T) {
258258
vr := &valueReader{
259-
src: &bufferedValueReader{buf: []byte{0x05, 0x00, 0x00, 0x00, 0x00}},
259+
src: &bufferedByteSrc{buf: []byte{0x05, 0x00, 0x00, 0x00, 0x00}},
260260
stack: []vrState{{mode: mTopLevel}},
261261
frame: 0,
262262
}
@@ -287,7 +287,7 @@ func TestValueReader_ReadDocument_TopLevel_ValidDocumentWithIncorrectEnd(t *test
287287
func TestValueReader_ReadDocument_EmbeddedDocument(t *testing.T) {
288288
t.Run("buffered", func(t *testing.T) {
289289
vr := &valueReader{
290-
src: &bufferedValueReader{buf: []byte{0x0a, 0x00, 0x00, 0x00, 0x05, 0x00, 0x00, 0x00, 0x00, 0x00}},
290+
src: &bufferedByteSrc{buf: []byte{0x0a, 0x00, 0x00, 0x00, 0x05, 0x00, 0x00, 0x00, 0x00, 0x00}},
291291
stack: []vrState{
292292
{mode: mTopLevel},
293293
{mode: mElement, vType: TypeBoolean},
@@ -461,7 +461,7 @@ func TestValueReader_ReadCodeWithScope(t *testing.T) {
461461
t.Run(tc.name, func(t *testing.T) {
462462
t.Run("buffered", func(t *testing.T) {
463463
vr := &valueReader{
464-
src: &bufferedValueReader{buf: tc.data},
464+
src: &bufferedByteSrc{buf: tc.data},
465465
stack: []vrState{
466466
{mode: mTopLevel},
467467
{
@@ -504,7 +504,7 @@ func TestValueReader_ReadCodeWithScope(t *testing.T) {
504504
doc = append(doc, codeWithScope...)
505505
doc = append(doc, 0x00)
506506
vr := &valueReader{
507-
src: &bufferedValueReader{buf: doc},
507+
src: &bufferedByteSrc{buf: doc},
508508
stack: []vrState{
509509
{mode: mTopLevel},
510510
{mode: mElement, vType: TypeCodeWithScope},
@@ -624,7 +624,7 @@ func TestValueReader_ReadDBPointer(t *testing.T) {
624624
t.Run(tc.name, func(t *testing.T) {
625625
t.Run("buffered", func(t *testing.T) {
626626
vr := &valueReader{
627-
src: &bufferedValueReader{buf: tc.data},
627+
src: &bufferedByteSrc{buf: tc.data},
628628
stack: []vrState{
629629
{mode: mTopLevel},
630630
{
@@ -710,7 +710,7 @@ func TestValueReader_ReadDateTime(t *testing.T) {
710710
t.Run(tc.name, func(t *testing.T) {
711711
t.Run("buffered", func(t *testing.T) {
712712
vr := &valueReader{
713-
src: &bufferedValueReader{buf: tc.data},
713+
src: &bufferedByteSrc{buf: tc.data},
714714
stack: []vrState{
715715
{mode: mTopLevel},
716716
{
@@ -793,7 +793,7 @@ func TestValueReader_ReadDecimal128(t *testing.T) {
793793
t.Run(tc.name, func(t *testing.T) {
794794
t.Run("buffered", func(t *testing.T) {
795795
vr := &valueReader{
796-
src: &bufferedValueReader{buf: tc.data},
796+
src: &bufferedByteSrc{buf: tc.data},
797797
stack: []vrState{
798798
{mode: mTopLevel},
799799
{
@@ -883,7 +883,7 @@ func TestValueReader_ReadDouble(t *testing.T) {
883883
t.Run(tc.name, func(t *testing.T) {
884884
t.Run("buffered", func(t *testing.T) {
885885
vr := &valueReader{
886-
src: &bufferedValueReader{buf: tc.data},
886+
src: &bufferedByteSrc{buf: tc.data},
887887
stack: []vrState{
888888
{mode: mTopLevel},
889889
{
@@ -963,7 +963,7 @@ func TestValueReader_ReadInt32(t *testing.T) {
963963
t.Run(tc.name, func(t *testing.T) {
964964
t.Run("buffered", func(t *testing.T) {
965965
vr := &valueReader{
966-
src: &bufferedValueReader{buf: tc.data},
966+
src: &bufferedByteSrc{buf: tc.data},
967967
stack: []vrState{
968968
{mode: mTopLevel},
969969
{
@@ -1043,7 +1043,7 @@ func TestValueReader_ReadInt64(t *testing.T) {
10431043
t.Run(tc.name, func(t *testing.T) {
10441044
t.Run("buffered", func(t *testing.T) {
10451045
vr := &valueReader{
1046-
src: &bufferedValueReader{buf: tc.data},
1046+
src: &bufferedByteSrc{buf: tc.data},
10471047
stack: []vrState{
10481048
{mode: mTopLevel},
10491049
{
@@ -1239,7 +1239,7 @@ func TestValueReader_ReadJavascript_ReadString_ReadSymbol(t *testing.T) {
12391239
t.Run(tc.name, func(t *testing.T) {
12401240
t.Run("buffered", func(t *testing.T) {
12411241
vr := &valueReader{
1242-
src: &bufferedValueReader{buf: tc.data},
1242+
src: &bufferedByteSrc{buf: tc.data},
12431243
stack: []vrState{
12441244
{mode: mTopLevel},
12451245
{
@@ -1356,7 +1356,7 @@ func TestValueReader_ReadMaxKey_ReadMinKey_ReadNull_ReadUndefined(t *testing.T)
13561356
t.Run(tc.name, func(t *testing.T) {
13571357
t.Run("buffered", func(t *testing.T) {
13581358
vr := &valueReader{
1359-
src: &bufferedValueReader{buf: []byte{}},
1359+
src: &bufferedByteSrc{buf: []byte{}},
13601360
stack: []vrState{
13611361
{mode: mTopLevel},
13621362
{
@@ -1432,7 +1432,7 @@ func TestValueReader_ReadObjectID(t *testing.T) {
14321432
t.Run(tc.name, func(t *testing.T) {
14331433
t.Run("buffered", func(t *testing.T) {
14341434
vr := &valueReader{
1435-
src: &bufferedValueReader{buf: tc.data},
1435+
src: &bufferedByteSrc{buf: tc.data},
14361436
stack: []vrState{
14371437
{mode: mTopLevel},
14381438
{
@@ -1524,7 +1524,7 @@ func TestValueReader_ReadRegex(t *testing.T) {
15241524
t.Run(tc.name, func(t *testing.T) {
15251525
t.Run("buffered", func(t *testing.T) {
15261526
vr := &valueReader{
1527-
src: &bufferedValueReader{buf: tc.data},
1527+
src: &bufferedByteSrc{buf: tc.data},
15281528
stack: []vrState{
15291529
{mode: mTopLevel},
15301530
{
@@ -1622,7 +1622,7 @@ func TestValueReader_ReadTimestamp(t *testing.T) {
16221622
t.Run(tc.name, func(t *testing.T) {
16231623
t.Run("buffered", func(t *testing.T) {
16241624
vr := &valueReader{
1625-
src: &bufferedValueReader{buf: tc.data},
1625+
src: &bufferedByteSrc{buf: tc.data},
16261626
stack: []vrState{
16271627
{mode: mTopLevel},
16281628
{
@@ -1987,7 +1987,7 @@ func TestValueReader_ReadBytes_Skip_Buffered(t *testing.T) {
19871987
t.Run(tc.name, func(t *testing.T) {
19881988
t.Run("Skip", func(t *testing.T) {
19891989
vr := &valueReader{
1990-
src: &bufferedValueReader{buf: tc.data, offset: tc.startingOffset},
1990+
src: &bufferedByteSrc{buf: tc.data, offset: tc.startingOffset},
19911991
stack: []vrState{
19921992
{mode: mTopLevel, end: startingEnd},
19931993
{mode: mElement, vType: tc.t},
@@ -2005,7 +2005,7 @@ func TestValueReader_ReadBytes_Skip_Buffered(t *testing.T) {
20052005
})
20062006
t.Run("ReadBytes", func(t *testing.T) {
20072007
vr := &valueReader{
2008-
src: &bufferedValueReader{buf: tc.data, offset: tc.startingOffset},
2008+
src: &bufferedByteSrc{buf: tc.data, offset: tc.startingOffset},
20092009
stack: []vrState{
20102010
{mode: mTopLevel, end: startingEnd},
20112011
{mode: mElement, vType: tc.t},
@@ -2059,7 +2059,7 @@ func TestValueReader_ReadBytes_Skip_Buffered(t *testing.T) {
20592059
t.Run(tc.name, func(t *testing.T) {
20602060
t.Parallel()
20612061
vr := &valueReader{
2062-
src: &bufferedValueReader{buf: tc.want},
2062+
src: &bufferedByteSrc{buf: tc.want},
20632063
stack: []vrState{
20642064
{mode: mTopLevel},
20652065
},

0 commit comments

Comments
 (0)