id

README

go-whosonfirst-id

Go package for generating valid Who's On First IDs.

Documentation

Example

Error handling omitted for the sake of brevity.

Simple

package main

import (
	"context"
	"fmt"
	"testing"
)

func main() {

	ctx := context.Background()
	pr, _ := NewProvider(ctx)

	id, _ := pr.NewID(ctx)
	fmt.Println(id)
}

Fancy

The default Provider does not pre-generate or cache IDs. To do so create a custom Provider that does, use the handy NewProviderWithURI method:

package main

import (
	_ "github.com/aaronland/go-uid-whosonfirst"
)

import (
	"context"
	"fmt"
	_ "github.com/aaronland/go-uid-proxy"	
)

func main() {

	ctx := context.Background()

	uri := "proxy:///?provider=whosonfirst://&minimum=5&pool=memory%3A%2F%2F"
	cl, _ := NewProviderWithURI(ctx, uri)

	id, _ := cl.NextInt(ctx)
	fmt.Println(id)
}

This expects a valid go-uid-proxy URI string.

See also

• https://github.com/aaronland/go-uid
• https://github.com/aaronland/go-uid-proxy
• https://github.com/aaronland/go-uid-artisanal
• https://github.com/aaronland/go-uid-whosonfirst
• https://github.com/aaronland/go-brooklynintegers-api

Documentation

Index

• Constants
• type Provider
  • func NewProvider(ctx context.Context) (Provider, error)
  • func NewProviderWithURI(ctx context.Context, uri string) (Provider, error)
• type WOFProvider
  • func (wof_pr *WOFProvider) NewID(ctx context.Context) (int64, error)

Constants

const EARTH int64 = constants.EARTH

EARTH is the Who's On First identifier for the planet Earth. This constant is DEPRECATED. Please use the equivalent constant in whosonfirst/go-whosonfirst-feature/constants

const ITS_COMPLICATED = constants.ITS_COMPLICATED

ITS_COMPLICATED is the identifier used to indicate that the parentage of a place is complicated in a geopolitical way too nuanced and complex to express otherwise. This constant is DEPRECATED. Please use the equivalent constant in whosonfirst/go-whosonfirst-feature/constants

const MULTIPLE_COUNTIES int64 = constants.MULTIPLE_COUNTIES

MULTIPLE_COUNTIES is the identifier used to indicate that a place is legitimately parented by multiple counties. For details consult https://github.com/whosonfirst/py-mapzen-whosonfirst-hierarchy/issues/1 This constant is DEPRECATED. Please use the equivalent constant in whosonfirst/go-whosonfirst-feature/constants

const MULTIPLE_NEIGHBOURHOODS int64 = constants.MULTIPLE_NEIGHBOURHOODS

MULTIPLE_NEIGHBOURHOODS is the identifier used to indicate that a place is legitimately parented by multiple neighbouhoods. This constant is DEPRECATED. Please use the equivalent constant in whosonfirst/go-whosonfirst-feature/constants

const MULTIPLE_PARENTS int64 = constants.MULTIPLE_PARENTS

MULTIPLE_PARENTS was a misnamed constant and is included for backward compatibility but should otherwise not be used. This constant is DEPRECATED. Please use the equivalent constant in whosonfirst/go-whosonfirst-feature/constants

const NULL_ISLAND int64 = constants.NULL_ISLAND

NULL_ISLAND is the Who's On First identifier for the Null Island. This constant is DEPRECATED. Please use the equivalent constant in whosonfirst/go-whosonfirst-feature/constants

const UNKNOWN int64 = constants.UNKNOWN

UNKNOWN is the identifier used to indicate that an otherwise valid identifier is unknown and needs to be resolved. This constant is DEPRECATED. Please use the equivalent constant in whosonfirst/go-whosonfirst-feature/constants

Types

type Provider

type Provider interface {
	// NewID returns a new unique 64-bit integers.
	NewID(context.Context) (int64, error)
}

type Provider is an interface for providing uniquer identifiers.

func NewProvider

func NewProvider(ctx context.Context) (Provider, error)

NweProvider returns a new `WOFProvider` instance configured with default settings.

func NewProviderWithURI

func NewProviderWithURI(ctx context.Context, uri string) (Provider, error)

NewProviderWithURI returns a new `WOFProvider` instance configured by 'uri' which is expected to be a valid `aaronland/go-uid-proxy` URI.

type WOFProvider

type WOFProvider struct {
	Provider
	// contains filtered or unexported fields
}

WOFProvider implements the Provider interface for generating unique Who's On First identifiers.

func (*WOFProvider) NewID

func (wof_pr *WOFProvider) NewID(ctx context.Context) (int64, error)

NewID returns a new Who's On First identifier.