export

README

go-whosonfirst-export

Go package for exporting Who's On First documents.

Install

You will need to have both Go (version 1.12 or higher) and the make programs installed on your computer. Assuming you do just type:

make tools

All of this package's dependencies are bundled with the code in the vendor directory.

What is this?

This is an experimental-cum-evolving package to format Who's On First documents in Go. It is meant to be a port of the py-mapzen-whosonfirst-geojson package and mmmmmmmaybe some or all of the py-mapzen-whosonfirst-export package.

It is also in flux and you should assume anything you see or read now will change.

Example

Simple

import (
	"github.com/whosonfirst/go-whosonfirst-export"
	"github.com/whosonfirst/go-whosonfirst-export/options"	
	"io/ioutil"
	"os
)

func main() {

	path := "some.geojson"     	
	fh, _ := os.Open(path)
	defer fh.Close()

	body, _ := ioutil.ReadAll(fh)

	opts, _ := options.NewDefaultOptions()
	export.Export(body, opts, os.Stdout)
}

Error handling removed for the sake of brevity.

To do

This package needs to hold hands with the go-whosonfirst-validate package.

See also

• https://github.com/tidwall/pretty
• https://github.com/tidwall/gjson
• https://github.com/tidwall/pretty/issues/2
• https://gist.github.com/tidwall/ca6ca1dd0cb780f0be4d134f8e4eb7bc
• https://github.com/whosonfirst/go-whosonfirst-validate

Documentation

Index

• func Export(feature []byte, opts options.Options, wr io.Writer) error
• func ExportChanged(feature []byte, existingFeature []byte, opts options.Options, wr io.Writer) (changed bool, err error)
• func Format(feature []byte, opts options.Options) ([]byte, error)
• func Prepare(feature []byte, opts options.Options) ([]byte, error)
• type Feature

Functions

func Export

func Export(feature []byte, opts options.Options, wr io.Writer) error

func ExportChanged

func ExportChanged(feature []byte, existingFeature []byte, opts options.Options, wr io.Writer) (changed bool, err error)

ExportChanged returns a boolean which indicates whether the file was changed by comparing it to the `existingFeature` byte slice, before the lastmodified timestamp is incremented. If the `feature` is identical to `existingFeature` it doesn't write to the `io.Writer`.

func Format

func Format(feature []byte, opts options.Options) ([]byte, error)

func Prepare

func Prepare(feature []byte, opts options.Options) ([]byte, error)

Types

type Feature

type Feature struct {
	Type       string      `json:"type"`
	Id         int64       `json:"id"`
	Properties interface{} `json:"properties"`
	Bbox       []float64   `json:"bbox,omitempty"`
	Geometry   interface{} `json:"geometry"`
}