MyXQL.GeometryCodec behaviour (MyXQL v0.8.2)

Copy Markdown View Source

Contract for encoding/decoding geometry types.

See "Geometry Support" section in the README for more information.

Summary

Types

no_srid()
some_srid()

Callbacks

decode(srid, wkb)
encode(struct)

Types

no_srid()

@type no_srid() :: 0

some_srid()

@type some_srid() :: pos_integer()

Callbacks

decode(srid, wkb)

@callback decode(srid :: no_srid() | some_srid(), wkb :: binary()) :: struct() | :unknown

encode(struct)

@callback encode(struct()) :: {srid :: integer(), wkb :: binary()} | :unknown