Packages
geo
3.2.0
4.1.0
4.0.1
4.0.0
3.6.0
3.5.1
3.5.0
3.4.3
3.4.2
3.4.1
3.4.0
3.3.8
3.3.7
3.3.5
3.3.4
3.3.3
3.3.2
3.3.1
3.3.0
3.2.0
3.1.0
3.0.0
2.1.0
2.0.0
1.5.0
1.4.1
1.4.0
1.3.1
1.3.0
1.2.1
1.2.0
1.1.2
1.1.1
1.1.0
1.0.6
1.0.5
1.0.4
1.0.3
1.0.2
1.0.1
1.0.0
0.18.0
0.17.0
0.16.1
0.16.0
0.15.2
0.15.1
0.15.0
0.14.0
0.13.0
0.12.0
0.11.2
0.11.1
0.11.0
0.10.1
0.10.0
0.9.3
0.9.2
0.9.1
0.9.0
0.8.0
0.7.2
0.7.1
0.6.1
0.5.1
Encodes and decodes WKB, WKT, and GeoJSON formats.
Current section
Files
Jump to
Current section
Files
lib/geo/json.ex
defmodule Geo.JSON do
alias Geo.JSON.{Decoder, Encoder}
@moduledoc """
Converts Geo structs to and from a map representing GeoJSON.
You are responsible to encoding and decoding of JSON. This is so
that you can use any JSON parser you want as well as making it
so that you can use the resulting GeoJSON structure as a property
in larger JSON structures.
```
#Using Poison as the JSON parser for these examples
json = "{ \\"type\\": \\"Point\\", \\"coordinates\\": [100.0, 0.0] }"
geom = Poison.decode!(json) |> Geo.JSON.decode!(json)
Geo.Point[coordinates: {100.0, 0.0}, srid: nil]
Geo.JSON.encode!(geom) |> Poison.encode!
"{ \\"type\\": \\"Point\\", \\"coordinates\\": [100.0, 0.0] }"
Geo.JSON.encode!(geom)
%{ "type" => "Point", "coordinates" => [100.0, 0.0] }
```
"""
@doc """
Takes a map representing GeoJSON and returns a Geometry
"""
@spec decode!(Map.t()) :: Geo.geometry() | no_return
defdelegate decode!(geo_json), to: Decoder
@doc """
Takes a map representing GeoJSON and returns a Geometry
"""
@spec decode(Map.t()) :: {:ok, Geo.geometry()} | {:error, Decoder.DecodeError.t()}
defdelegate decode(geo_json), to: Decoder
@doc """
Takes a Geometry and returns a map representing the GeoJSON
"""
@spec encode!(Geo.geometry()) :: Map.t() | no_return
defdelegate encode!(geom), to: Encoder
@doc """
Takes a Geometry and returns a map representing the GeoJSON
"""
@spec encode(Geo.geometry()) :: {:ok, Map.t()} | {:error, Encoder.EncodeError.t()}
defdelegate encode(geom), to: Encoder
end