cairnapp / go-geobuf

Compact GeoJSON encoding for Golang

Go Geobuf

A compact Protobuf representation of GeoJSON. Based on Mapbox's geobuf.

Limitations

Due to the nature of Go being a statically typed language, custom properties are not currently supported.

Some properties may lose their types through encoding/decoding. For instance, int8s may become uints or just ints.

Encoding/Decoding

A basic example shows how this library will infer the proper precision for encoding/decoding

import (
    "github.com/cairnapp/go-geobuf"
    "github.com/cairnapp/go-geobuf/pkg/geometry"
    "github.com/cairnapp/go-geobuf/pkg/geojson"
)

point := geojson.NewGeometry(geometry.Point([]float64{
    124.123, 
    234.456
}))
data := geobuf.Encode(point)
decoded_point := geobuf.Decode(point)

go-geobuf's Issues

Explore ways to handle custom properties

Since go is statically typed, custom properties are not really supported, neither are they part of the GeoJSON spec.

However, geobuf/pygeobuf are dynamically typed and therefor encode extra properties on any of the json objects.

Finding a way to expose or pull out the custom properties would be nice, but non-essential for the initial release (as they aren't part of the spec). However, if I can find a nice way to support it with minimal effort, I'll go for it.

The best way I can think of right now is to support it in decode only, perhaps returning it with type loss or with a provided schema.

Be able to provide a schema for feature properties to avoid type-loss.

Right now when we decode properties, we lose some type information, like int8, int16, int32 and int64 will all get converted to int or uint on the way out. I'm proposing passing in a schema for your properties to decode out to, similar to how JSON encoding/decoding works.

how to convert geobuf to []byte

can mapbox geobuf decode this?