lookup

package

v0.0.0-...-943c59f Latest Latest Go to latest Published: Jul 29, 2017 License: MIT Imports: 10 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

func CreateBuntDB(dbFile, locationFile string) error

CreateBuntDB is called by the CLI tool -create. This removes any existing keys before doing the import.

type ByDistance struct{ Locations }

ByDistance is a convenience type for sorting locations by their distance.

func (s ByDistance) Less(i, j int) bool

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

DB contains the underlying buntdb for Geo lookups, and in the future may not even be buntdb.

func TryOpenDB(dbFile, locationFile string) (*DB, error)

TryOpenDB opens dbFile if it exists, otherwise it reads locationFile. If locationFile also does not exist, a builtin dataset is used.

This complexity is so that the command line server example can be run with no required files or flags.

Caller must call Close() on DB when done.

func (lu *DB) Close() error

Close closes the underlying DB. Must call when done with your *DB.

func (lu *DB) FindNearest(lat, lon float64, maxResults int) (Locations, error)

FindNearest returns up to maxResults near lat/lon. Naive implementation.

type Location struct {
	Name     string
	Lat      float64
	Lon      float64
	Distance float64
}

Location holds one positions data as returned from the DB.

type Locations []*Location

func (s Locations) Len() int

func (s Locations) Swap(i, j int)