Skip to content

Remove (*Reader).Decode #150

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 5 additions & 19 deletions reader.go
Original file line number Diff line number Diff line change
Expand Up @@ -150,28 +150,14 @@ func (r *Reader) Lookup(ip netip.Addr) Result {
}
}

// Decode the record at |offset| into |result|. The result value pointed to
// must be a data value that corresponds to a record in the database. This may
// include a struct representation of the data, a map capable of holding the
// data or an empty any value.
//
// If result is a pointer to a struct, the struct need not include a field
// for every value that may be in the database. If a field is not present in
// the structure, the decoder will not decode that field, reducing the time
// required to decode the record.
//
// As a special case, a struct field of type uintptr will be used to capture
// the offset of the value. Decode may later be used to extract the stored
// value from the offset. MaxMind DBs are highly normalized: for example in
// the City database, all records of the same country will reference a
// single representative record for that country. This uintptr behavior allows
// clients to leverage this normalization in their own sub-record caching.
func (r *Reader) Decode(offset uintptr, result any) error {
// LookupOffset returns the Result for the specified offset. Note that
// netip.Prefix returned by Networks will be invalid when using LookupOffset.
func (r *Reader) LookupOffset(offset uintptr) Result {
if r.buffer == nil {
return errors.New("cannot call Decode on a closed database")
return Result{err: errors.New("cannot call Decode on a closed database")}
}

return Result{decoder: r.decoder, offset: uint(offset)}.Decode(result)
return Result{decoder: r.decoder, offset: uint(offset)}
}

var zeroIP = netip.MustParseAddr("::")
Expand Down
17 changes: 11 additions & 6 deletions reader_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -311,7 +311,8 @@ func TestDecoder(t *testing.T) {
require.NoError(t, result.Err())
require.True(t, result.Found())

require.NoError(t, reader.Decode(result.RecordOffset(), &testV))
res := reader.LookupOffset(result.RecordOffset())
require.NoError(t, res.Decode(&testV))
verify(testV)
}

Expand Down Expand Up @@ -563,21 +564,25 @@ func TestNestedOffsetDecode(t *testing.T) {
TimeZoneOffset uintptr `maxminddb:"time_zone"`
} `maxminddb:"location"`
}
require.NoError(t, db.Decode(result.RecordOffset(), &root))
res := db.LookupOffset(result.RecordOffset())
require.NoError(t, res.Decode(&root))
assert.InEpsilon(t, 51.5142, root.Location.Latitude, 1e-10)

var longitude float64
require.NoError(t, db.Decode(root.Location.LongitudeOffset, &longitude))
res = db.LookupOffset(root.Location.LongitudeOffset)
require.NoError(t, res.Decode(&longitude))
assert.InEpsilon(t, -0.0931, longitude, 1e-10)

var timeZone string
require.NoError(t, db.Decode(root.Location.TimeZoneOffset, &timeZone))
res = db.LookupOffset(root.Location.TimeZoneOffset)
require.NoError(t, res.Decode(&timeZone))
assert.Equal(t, "Europe/London", timeZone)

var country struct {
IsoCode string `maxminddb:"iso_code"`
}
require.NoError(t, db.Decode(root.CountryOffset, &country))
res = db.LookupOffset(root.CountryOffset)
require.NoError(t, res.Decode(&country))
assert.Equal(t, "GB", country.IsoCode)

require.NoError(t, db.Close())
Expand Down Expand Up @@ -680,7 +685,7 @@ func TestUsingClosedDatabase(t *testing.T) {
err = reader.Lookup(addr).Decode(recordInterface)
assert.Equal(t, "cannot call Lookup on a closed database", err.Error())

err = reader.Decode(0, recordInterface)
err = reader.LookupOffset(0).Decode(recordInterface)
assert.Equal(t, "cannot call Decode on a closed database", err.Error())
}

Expand Down
Loading