geodbtools

type CityRecord interface {
	CountryRecord

	// GetCityName returns the name of the city
	GetCityName() string
}

type CountryRecord interface {
	Record

	// GetCountryCode returns the 2-character ISO country code
	GetCountryCode() string
}

type DatabaseType string

type Format interface {
	// FormatName returns the format's name
	FormatName() string

	// NewReader returns a new reader instance from the given io.ReaderAt
	// This method will return not only a reader instance, but also the database metadata
	// retrieved from the ReaderAt instance.
	NewReaderAt(r ReaderSource) (reader Reader, meta Metadata, err error)

	// NewWriter returns a new writer instance writing to the given io.Writer
	NewWriter(w io.Writer, dbType DatabaseType, ipVersion IPVersion) (writer Writer, err error)

	// DetectFormat checks if the data represented by the passed io.ReaderAt are of the given format
	DetectFormat(r ReaderSource) (isFormat bool)
}

type IPVersion uint

type Metadata struct {
	// Type holds the database type
	Type DatabaseType
	// BuildTime holds the database's build time
	BuildTime time.Time
	// Description holds the human-readable database description
	Description string

	// MajorFormatVersion holds the major version number of the database format
	MajorFormatVersion uint
	// MinorFormatVersion holds the minor version number of the database format
	MinorFormatVersion uint

	// IPVersion holds the IP version represented by the database.
	// This may be IPVersionUndefined for databases non-IP databases
	IPVersion IPVersion
}

type Reader interface {
	// RecordTree returns the database's underlying RecordTree instance, selecting the desired IP version.
	// Note that this is an expensive operation and is not needed for running lookups against the database.
	RecordTree(ipVersion IPVersion) (tree *RecordTree, err error)

	// LookupIP retrieves the record for the given IP address
	LookupIP(ip net.IP) (record Record, err error)
}

type ReaderSource interface {
	io.ReaderAt

	// Size returns the overall size of the underlying ReaderAt
	Size() int64

	// Close frees up memory used by underlying source object
	Close() error
}

type Record interface {
	fmt.Stringer

	// GetNetwork returns the network represented by the record
	GetNetwork() *net.IPNet
}

type RecordBelongsRightFunc func(b []byte, depth uint) bool

type RecordTree struct {
	// contains filtered or unexported fields
}

type VerificationError struct {
	ExpectedRecord Record
	Record         Record
	LookupError    error
}

type VerificationProgress struct {
	TotalRecords   int
	CheckedRecords int
}

type Writer interface {
	// WriteDatabase writes the database given the database metadata and a given record tree
	WriteDatabase(meta Metadata, tree *RecordTree) (err error)
}