Geography.VectorTile.Protobuf

Most of the details of Protobuf conversion are kept in Geometry.VectorTile.Protobuf.Internal, a module which is not intended to be imported.

A user's main concern here should be the Protobuffable class, and its VectorTile instance. With it, one can do the following:

import Geography.VectorTile.Protobuf

decode bytes >>= fromProtobuf  -- Either Text VectorTile

which in fact is sugared in the top-level module of this library as:

decode bytes >>= tile

Types

class Protobuffable a where

A type which can be converted to and from an underlying Protobuf type, according to the Protobuf type family.

Minimal complete definition

fromProtobuf, toProtobuf

Methods

fromProtobuf :: Protobuf a -> Either Text a

toProtobuf :: a -> Protobuf a

Instances

Protobuffable Val

Methods

fromProtobuf :: Protobuf Val -> Either Text Val

toProtobuf :: Val -> Protobuf Val

Protobuffable Layer

Methods

fromProtobuf :: Protobuf Layer -> Either Text Layer

toProtobuf :: Layer -> Protobuf Layer

Protobuffable VectorTile

Methods

fromProtobuf :: Protobuf VectorTile -> Either Text VectorTile

toProtobuf :: VectorTile -> Protobuf VectorTile

ByteString Encoding / Decoding

decode :: ByteString -> Either Text RawVectorTile

Attempt to decode a ByteString of raw protobuf data into a mid-level representation of a RawVectorTile.

encode :: RawVectorTile -> ByteString

Encode a mid-level representation of a RawVectorTile into raw protobuf data.

decodeIO :: FilePath -> IO (Either Text RawVectorTile)

Given a filename, attempt to decode bytes read from that file.

encodeIO :: RawVectorTile -> FilePath -> IO ()

Write a mid-level representation of a RawVectorTile to a file as raw protobuf data.