Skip to content

Commit 018782a

Browse files
committed
Make capitalization of uint consistent
1 parent 8ea2bb6 commit 018782a

File tree

7 files changed

+28
-19
lines changed

7 files changed

+28
-19
lines changed

CHANGELOG.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
11
# Changes
22

3+
## 2.0.0-beta.7 - 2025-07-07
4+
5+
* Update capitalization of "uint" in `ReadUInt*` to match `KindUint*` as well
6+
as the Go standard library.
7+
8+
## 2.0.0-beta.6 - 2025-07-07
9+
10+
* Invalid release with no code changes.
11+
312
## 2.0.0-beta.5 - 2025-07-06
413

514
- Added `Offset()` method to `Decoder` to get the current database offset. This

example_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -223,7 +223,7 @@ func (c *CustomCity) UnmarshalMaxMindDB(d *mmdbdata.Decoder) error {
223223
}
224224
c.Names = names
225225
case "geoname_id":
226-
geoID, err := d.ReadUInt32()
226+
geoID, err := d.ReadUint32()
227227
if err != nil {
228228
return err
229229
}

internal/decoder/decoder.go

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -142,10 +142,10 @@ func (d *Decoder) ReadInt32() (int32, error) {
142142
return value, nil
143143
}
144144

145-
// ReadUInt16 reads the value pointed by the decoder as a uint16.
145+
// ReadUint16 reads the value pointed by the decoder as a uint16.
146146
//
147147
// Returns an error if the database is malformed or if the pointed value is not an uint16.
148-
func (d *Decoder) ReadUInt16() (uint16, error) {
148+
func (d *Decoder) ReadUint16() (uint16, error) {
149149
size, offset, err := d.decodeCtrlDataAndFollow(KindUint16)
150150
if err != nil {
151151
return 0, d.wrapError(err)
@@ -160,10 +160,10 @@ func (d *Decoder) ReadUInt16() (uint16, error) {
160160
return value, nil
161161
}
162162

163-
// ReadUInt32 reads the value pointed by the decoder as a uint32.
163+
// ReadUint32 reads the value pointed by the decoder as a uint32.
164164
//
165165
// Returns an error if the database is malformed or if the pointed value is not an uint32.
166-
func (d *Decoder) ReadUInt32() (uint32, error) {
166+
func (d *Decoder) ReadUint32() (uint32, error) {
167167
size, offset, err := d.decodeCtrlDataAndFollow(KindUint32)
168168
if err != nil {
169169
return 0, d.wrapError(err)
@@ -178,10 +178,10 @@ func (d *Decoder) ReadUInt32() (uint32, error) {
178178
return value, nil
179179
}
180180

181-
// ReadUInt64 reads the value pointed by the decoder as a uint64.
181+
// ReadUint64 reads the value pointed by the decoder as a uint64.
182182
//
183183
// Returns an error if the database is malformed or if the pointed value is not an uint64.
184-
func (d *Decoder) ReadUInt64() (uint64, error) {
184+
func (d *Decoder) ReadUint64() (uint64, error) {
185185
size, offset, err := d.decodeCtrlDataAndFollow(KindUint64)
186186
if err != nil {
187187
return 0, d.wrapError(err)
@@ -196,10 +196,10 @@ func (d *Decoder) ReadUInt64() (uint64, error) {
196196
return value, nil
197197
}
198198

199-
// ReadUInt128 reads the value pointed by the decoder as a uint128.
199+
// ReadUint128 reads the value pointed by the decoder as a uint128.
200200
//
201201
// Returns an error if the database is malformed or if the pointed value is not an uint128.
202-
func (d *Decoder) ReadUInt128() (hi, lo uint64, err error) {
202+
func (d *Decoder) ReadUint128() (hi, lo uint64, err error) {
203203
size, offset, err := d.decodeCtrlDataAndFollow(KindUint128)
204204
if err != nil {
205205
return 0, 0, d.wrapError(err)

internal/decoder/decoder_test.go

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -251,7 +251,7 @@ func TestDecodeUint16(t *testing.T) {
251251
for hexStr, expected := range tests {
252252
t.Run(hexStr, func(t *testing.T) {
253253
decoder := newDecoderFromHex(t, hexStr)
254-
result, err := decoder.ReadUInt16() // [cite: 42]
254+
result, err := decoder.ReadUint16() // [cite: 42]
255255
require.NoError(t, err)
256256
require.Equal(t, expected, result)
257257
require.True(t, decoder.hasNextOffset || decoder.offset > 0, "Offset was not advanced")
@@ -273,7 +273,7 @@ func TestDecodeUint32(t *testing.T) {
273273
for hexStr, expected := range tests {
274274
t.Run(hexStr, func(t *testing.T) {
275275
decoder := newDecoderFromHex(t, hexStr)
276-
result, err := decoder.ReadUInt32() // [cite: 44]
276+
result, err := decoder.ReadUint32() // [cite: 44]
277277
require.NoError(t, err)
278278
require.Equal(t, expected, result)
279279
require.True(t, decoder.hasNextOffset || decoder.offset > 0, "Offset was not advanced")
@@ -295,7 +295,7 @@ func TestDecodeUint64(t *testing.T) {
295295
for hexStr, expected := range tests {
296296
t.Run(hexStr, func(t *testing.T) {
297297
decoder := newDecoderFromHex(t, hexStr)
298-
result, err := decoder.ReadUInt64() // [cite: 46]
298+
result, err := decoder.ReadUint64() // [cite: 46]
299299
require.NoError(t, err)
300300
require.Equal(t, expected, result)
301301
require.True(t, decoder.hasNextOffset || decoder.offset > 0, "Offset was not advanced")
@@ -321,7 +321,7 @@ func TestDecodeUint128(t *testing.T) {
321321
for hexStr, expected := range tests {
322322
t.Run(hexStr, func(t *testing.T) {
323323
decoder := newDecoderFromHex(t, hexStr)
324-
hi, lo, err := decoder.ReadUInt128() // [cite: 48]
324+
hi, lo, err := decoder.ReadUint128() // [cite: 48]
325325
require.NoError(t, err)
326326

327327
// Reconstruct the big.Int from hi and lo parts for comparison
@@ -405,15 +405,15 @@ func TestBoundsChecking(t *testing.T) {
405405
require.Error(t, err)
406406
require.Contains(t, err.Error(), "exceeds buffer length")
407407

408-
// Test DecodeUInt128 bounds checking
408+
// Test DecodeUint128 bounds checking
409409
uint128Buffer := []byte{
410410
0x0B,
411411
0x03,
412412
} // Extended type (0x0), size 11, TypeUint128-7=3, but only 2 bytes total
413413
dd2 := NewDataDecoder(uint128Buffer)
414414
decoder2 := NewDecoder(dd2, 0)
415415

416-
_, _, err = decoder2.ReadUInt128()
416+
_, _, err = decoder2.ReadUint128()
417417
require.Error(t, err)
418418
require.Contains(t, err.Error(), "unexpected end of database")
419419
}

internal/decoder/nested_unmarshaler_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ type testItem struct {
125125

126126
func (item *testItem) UnmarshalMaxMindDB(d *Decoder) error {
127127
item.custom = true
128-
id, err := d.ReadUInt32()
128+
id, err := d.ReadUint32()
129129
if err != nil {
130130
return err
131131
}

mmdbdata/doc.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
// }
3232
// c.Names = names
3333
// case "geoname_id":
34-
// geoID, err := d.ReadUInt32()
34+
// geoID, err := d.ReadUint32()
3535
// if err != nil { return err }
3636
// c.GeoNameID = uint(geoID)
3737
// default:

reader_test.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1148,7 +1148,7 @@ func (c *TestCity) UnmarshalMaxMindDB(d *mmdbdata.Decoder) error {
11481148
}
11491149
c.Names = names
11501150
case "geoname_id":
1151-
geoID, err := d.ReadUInt32()
1151+
geoID, err := d.ReadUint32()
11521152
if err != nil {
11531153
return err
11541154
}
@@ -1188,7 +1188,7 @@ func (a *TestASN) UnmarshalMaxMindDB(d *mmdbdata.Decoder) error {
11881188
}
11891189
a.AutonomousSystemOrganization = org
11901190
case "autonomous_system_number":
1191-
asn, err := d.ReadUInt32()
1191+
asn, err := d.ReadUint32()
11921192
if err != nil {
11931193
return err
11941194
}

0 commit comments

Comments
 (0)