gnis

Documentation

Index

• type Client
  • func NewClient(opts ...Option) (*Client, error)
• type GeoNamesService
  • func (s *GeoNamesService) Query(ctx context.Context, state string) ([]*GeographicName, error)
• type GeographicName
  • func (g *GeographicName) GeoJSON() (*geojson.Feature, error)
  • func (g *GeographicName) MarshalJSON() ([]byte, error)
• type Option
  • func WithHTTPClient(client *http.Client) Option
  • func WithHTTPTracing(debug bool) Option
  • func WithTransport(t http.RoundTripper) Option

Types

type Client

type Client struct {
	GeoNames *GeoNamesService
	// contains filtered or unexported fields
}

Client provides access to the GNIS database

func NewClient

func NewClient(opts ...Option) (*Client, error)

NewClient creates a new client and applies all provided Options

type GeoNamesService

type GeoNamesService service

GeoNamesService used to query geonames

func (*GeoNamesService) Query

func (s *GeoNamesService) Query(ctx context.Context, state string) ([]*GeographicName, error)

Query GNIS for geonames

type GeographicName

type GeographicName struct {
	ID     string      `json:"id,omitempty"`
	Name   string      `json:"name,omitempty"`
	Source string      `json:"source,omitempty"`
	Class  string      `json:"class,omitempty"`
	Locale string      `json:"locale,omitempty"`
	Point  *geom.Point `json:"point,omitempty"`
}

GeographicName information about the official name for places, features, and areas

func (*GeographicName) GeoJSON

func (g *GeographicName) GeoJSON() (*geojson.Feature, error)

func (*GeographicName) MarshalJSON

func (g *GeographicName) MarshalJSON() ([]byte, error)

type Option

type Option func(*Client) error

Option provides a configuration mechanism for a Client

func WithHTTPClient

func WithHTTPClient(client *http.Client) Option

WithHTTPClient sets the underlying http client.

func WithHTTPTracing

func WithHTTPTracing(debug bool) Option

WithHTTPTracing enables tracing http calls.

func WithTransport

func WithTransport(t http.RoundTripper) Option

WithTransport sets the underlying http client transport.