Decode unmarshals the data from the data section into the value pointed to by v. If v is nil or not a pointer, an error is returned. If the data in th

New creates a [ReflectionDecoder].

Open takes a string path to a MaxMind DB file and any options. It returns a Reader structure or an error. The database file is opened using a memory m

NewInvalidDatabaseError creates an [InvalidDatabaseError] using the provided format and format arguments.

Close returns the resources used by the database to the system.

Decode decodes the data value at offset and stores it in the value pointed at by v.

Lookup retrieves the database record for ip and returns a Result, which can be used to decode the data.

Err provides a way to check whether there was an error during the lookup without calling Result.Decode. If there was an error, it will also be returne

NewDataDecoder creates a [DataDecoder].

wrapError wraps an error with context information when an error occurs. Zero allocation on happy path - only allocates when error != nil.

NewDecoder creates a new Decoder with the given DataDecoder, offset, and options.

ReadString reads the value pointed by the decoder as a string. Returns an error if the database is malformed or if the pointed value is not a string.

String returns a human-readable name for the Kind.

Prefix returns the netip.Prefix representing the network associated with the data record in the database.

decodeCtrlData decodes the control byte and data info at the given offset. Encoding follows the MaxMind DB spec: the control byte's high 3 bits encode

DecodePath unmarshals a value from data section into v, following the specified path. The v parameter should be a pointer to the value where the deco

NewOffsetError creates an [InvalidDatabaseError] indicating that an offset pointed beyond the end of the database.

Found will return true if the IP was found in the search tree. It will return false if the IP was not found or if there was an error.

Networks returns an iterator that can be used to traverse the networks in the database. Please note that a MaxMind DB may map IPv4 networks into seve

ReadMap returns an iterator to read the map along with the map size. The size can be used to pre-allocate a map with the correct capacity for better p

Helper function to create a Decoder for a given hex string.

NextValueOffset skips ahead to the next value without decoding the one at the offset passed in. The size bits have different meanings for different da

DecodeKey decodes a map key into []byte slice. We use a []byte so that we can take advantage of https://github.com/golang/go/issues/3512 to avoid copy

internAt returns a string for the data at the given offset and size. Hot offsets are interned and the same backing string is returned on subsequent hi

NewUnmarshalTypeError creates an [UnmarshalTypeError] when the value cannot be assigned to a value of rType.

OpenBytes takes a byte slice corresponding to a MaxMind DB file and any options. It returns a Reader structure or an error.

WrapWithContext wraps an error with offset and optional path context. This function is designed to have zero allocation on the happy path - it only al

DecodePointer decodes a pointer from the given offset.

LookupOffset returns the Result for the specified offset. Note that netip.Prefix returned by Networks will be invalid when using LookupOffset.

NetworksWithin returns an iterator that can be used to traverse the networks in the database which are contained in a given prefix. Please note that

Build constructs the full path string.

PrependMap adds a map key to the beginning of the path (for retroactive building).

NewPathBuilder creates a new path builder.

Offset returns the offset of the record in the database. This can be passed to (*Reader).LookupOffset. It can also be used as a unique identifier for

PeekKind returns the kind of the current value without consuming it. This allows for look-ahead parsing similar to jsontext.Decoder.PeekKind().

ReadUint32 reads the value pointed by the decoder as a uint32. Returns an error if the database is malformed or if the pointed value is not a uint32.

SkipEmptyValues is an option for Networks and NetworksWithin that makes them skip networks whose data is an empty map or empty array. This is useful f

NewUnmarshalTypeStrError creates an [UnmarshalTypeError] when the string value cannot be assigned to a value of rType.

ReadSlice returns an iterator over the values of the slice along with the slice size. The size can be used to pre-allocate a slice with the correct ca

Verify performs comprehensive validation of the MaxMind DB file. This method validates: - Metadata section: format versions, required fields, and val

DecodeString decodes a string from the given offset.

DecodeUint16 decodes a 16-bit unsigned integer from the given offset.

DecodeUint32 decodes a 32-bit unsigned integer from the given offset.

DecodeUint64 decodes a 64-bit unsigned integer from the given offset.

decodeValueSkipUnmarshaler is the struct-field fast path: when the destination type was precomputed to not implement Unmarshaler, we skip the reflecti

makeStructFields implements json/v2 style field precedence rules.

IncludeNetworksWithoutData is an option for Networks and NetworksWithin that makes them include networks without any data in the iteration.

IsContainer returns true if the Kind represents a container type (Map or Slice).

IsEmptyValueAt checks if the value at the given offset is an empty map or array. Returns true if the value is a map or array with size 0.

IsScalar returns true if the Kind represents a scalar value type.

ReadUint64 reads the value pointed by the decoder as a uint64. Returns an error if the database is malformed or if the pointed value is not a uint64.

SkipValue skips over the current value without decoding it. This is useful in custom decoders when encountering unknown fields. The decoder will be po

DecodeBool decodes a boolean from the given offset.

DecodeFloat64 decodes a 64-bit float from the given offset.

getAllTestMMDBFiles returns smaller MMDB files from the test-data directory. Large files are excluded to keep fuzzing fast and prevent timeouts.

getBuffer returns the underlying buffer for direct access.

isInIPv4Subtree returns true if the IP is in the database's IPv4 subtree.

Converts an IPv4 address embedded in IPv6 to IPv4.

BuildTime returns the database build time as a time.Time. This is a convenience method that converts the BuildEpoch field from Unix epoch seconds to a

ParseAndExtend parses an existing path and extends this builder with those segments. This is used for retroactive path building during error unwinding

PrependSlice adds a slice index to the beginning of the path (for retroactive building).

ReadBool reads the value pointed by the decoder as a bool. Returns an error if the database is malformed or if the pointed value is not a bool.

ReadBytes reads the value pointed by the decoder as bytes. Returns an error if the database is malformed or if the pointed value is not bytes.

ReadFloat64 reads the value pointed by the decoder as a float64. Returns an error if the database is malformed or if the pointed value is not a doubl

ReadUint128 reads the value pointed by the decoder as a uint128. Returns an error if the database is malformed or if the pointed value is not a uint1

ReadUint16 reads the value pointed by the decoder as a uint16. Returns an error if the database is malformed or if the pointed value is not a uint16.

DecodeFloat32 decodes a 32-bit float from the given offset.

DecodeInt32 decodes a 32-bit signed integer from the given offset.