geocode

Documentation

Overview

Package geocode handles mapping user-entered locations into lat/long polygons.

Index

• Variables
• func GetAPIKey() (string, error)
• func GetAPIKeyPath() (string, error)
• type LatLong
• type Rect
  • func Lookup(ctx context.Context, address string) ([]Rect, error)

Variables

var AltLookupFn func(ctx context.Context, address string) ([]Rect, error)

AltLookupFn provides alternative geocode lookup in tests.

If AltLookupFn is not nil, Lookup returns the results of the AltLookupFn call.

Lookup performs its standard lookup using its cache and the Google geocoding service if AltLookupFn is nil, or it returns (nil, nil) for the address being looked up.

It's up to the caller to change AltLookupFn only when Lookup is not being called.

var ErrNoGoogleKey = errors.New("geocode: geocoding is not configured; see https://perkeep.org/doc/geocoding")

Functions

func GetAPIKey

func GetAPIKey() (string, error)

GetAPIKey returns the Google geocoding API key stored in the Perkeep configuration directory as google-geocode.key.

func GetAPIKeyPath

func GetAPIKeyPath() (string, error)

GetAPIKeyPath returns the file path to the Google geocoding API key.

Types

type LatLong

type LatLong struct {
	Lat  float64 `json:"lat"`
	Long float64 `json:"lng"`
}

type Rect

type Rect struct {
	NorthEast LatLong `json:"northeast"`
	SouthWest LatLong `json:"southwest"`
}

func Lookup

func Lookup(ctx context.Context, address string) ([]Rect, error)

Lookup returns rectangles for the given address. Currently the only implementation is the Google geocoding service.