ewkb

package
v1.4.1-0...-a4d69fd Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 2, 2021 License: BSD-2-Clause Imports: 8 Imported by: 0

Documentation

Overview

Package ewkb implements Extended Well Known Binary encoding and decoding. See https://github.com/postgis/postgis/blob/2.1.0/doc/ZMSgeoms.txt.

If you are encoding geometries in EWKB to send to PostgreSQL/PostGIS, then you must specify binary_parameters=yes in the data source name that you pass to sql.Open.

Example (Scan)
type City struct {
	Name     string
	Location ewkb.Point
}

db, mock, err := sqlmock.New()
if err != nil {
	log.Fatal(err)
}
defer db.Close()

mock.ExpectQuery(`SELECT name, ST_AsEWKB\(location\) FROM cities WHERE name = \?;`).
	WithArgs("London").
	WillReturnRows(
		sqlmock.NewRows([]string{"name", "location"}).
			AddRow("London", geomtest.MustHexDecode("0101000020e610000052b81e85eb51c03f45f0bf95ecc04940")),
	)

var c City
if err := db.QueryRow(`SELECT name, ST_AsEWKB(location) FROM cities WHERE name = ?;`, "London").Scan(&c.Name, &c.Location); err != nil {
	log.Fatal(err)
}

fmt.Printf("Longitude: %v\n", c.Location.X())
fmt.Printf("Latitude: %v\n", c.Location.Y())
fmt.Printf("SRID: %v\n", c.Location.SRID())
Output:

Longitude: 0.1275
Latitude: 51.50722
SRID: 4326
Example (Value)
type City struct {
	Name     string
	Location ewkb.Point
}

db, mock, err := sqlmock.New()
if err != nil {
	log.Fatal(err)
}
defer db.Close()

mock.ExpectExec(`INSERT INTO cities \(name, location\) VALUES \(\?, \?\);`).
	WithArgs("London", geomtest.MustHexDecode("0101000020e610000052b81e85eb51c03f45f0bf95ecc04940")).
	WillReturnResult(sqlmock.NewResult(1, 1))

c := City{
	Name:     "London",
	Location: ewkb.Point{Point: geom.NewPoint(geom.XY).MustSetCoords(geom.Coord{0.1275, 51.50722}).SetSRID(4326)},
}

result, err := db.Exec(`INSERT INTO cities (name, location) VALUES (?, ?);`, c.Name, &c.Location)
if err != nil {
	log.Fatal(err)
}
rowsAffected, _ := result.RowsAffected()
fmt.Printf("%d rows affected", rowsAffected)
Output:

1 rows affected

Index

Examples

Constants

This section is empty.

Variables

View Source
var (
	// XDR is big endian.
	XDR = wkbcommon.XDR
	// NDR is little endian.
	NDR = wkbcommon.NDR
)

Functions

func Marshal

func Marshal(g geom.T, byteOrder binary.ByteOrder) ([]byte, error)

Marshal marshals an arbitrary geometry to a []byte.

func Read

func Read(r io.Reader) (geom.T, error)

Read reads an arbitrary geometry from r.

func Unmarshal

func Unmarshal(data []byte) (geom.T, error)

Unmarshal unmrshals an arbitrary geometry from a []byte.

func Write

func Write(w io.Writer, byteOrder binary.ByteOrder, g geom.T) error

Write writes an arbitrary geometry to w.

Types

type ErrExpectedByteSlice

type ErrExpectedByteSlice struct {
	Value interface{}
}

ErrExpectedByteSlice is returned when a []byte is expected.

func (ErrExpectedByteSlice) Error

func (e ErrExpectedByteSlice) Error() string

type GeometryCollection

type GeometryCollection struct {
	*geom.GeometryCollection
}

A GeometryCollection is a EWKB-encoded GeometryCollection that implements the sql.Scanner and driver.Value interfaces.

func (*GeometryCollection) Scan

func (gc *GeometryCollection) Scan(src interface{}) error

Scan scans from a []byte.

func (*GeometryCollection) Valid

func (gc *GeometryCollection) Valid() bool

Valid returns true if gc has a value.

func (*GeometryCollection) Value

func (gc *GeometryCollection) Value() (driver.Value, error)

Value returns the EWKB encoding of gc.

type LineString

type LineString struct {
	*geom.LineString
}

A LineString is a EWKB-encoded LineString that implements the sql.Scanner and driver.Value interfaces.

func (*LineString) Scan

func (ls *LineString) Scan(src interface{}) error

Scan scans from a []byte.

func (*LineString) Valid

func (ls *LineString) Valid() bool

Valid return true if ls has a value.

func (*LineString) Value

func (ls *LineString) Value() (driver.Value, error)

Value returns the EWKB encoding of ls.

type MultiLineString

type MultiLineString struct {
	*geom.MultiLineString
}

A MultiLineString is a EWKB-encoded MultiLineString that implements the sql.Scanner and driver.Value interfaces.

func (*MultiLineString) Scan

func (mls *MultiLineString) Scan(src interface{}) error

Scan scans from a []byte.

func (*MultiLineString) Valid

func (mls *MultiLineString) Valid() bool

Valid returns true if mls has a value.

func (*MultiLineString) Value

func (mls *MultiLineString) Value() (driver.Value, error)

Value returns the EWKB encoding of mls.

type MultiPoint

type MultiPoint struct {
	*geom.MultiPoint
}

A MultiPoint is a EWKB-encoded MultiPoint that implements the sql.Scanner and driver.Value interfaces.

func (*MultiPoint) Scan

func (mp *MultiPoint) Scan(src interface{}) error

Scan scans from a []byte.

func (*MultiPoint) Valid

func (mp *MultiPoint) Valid() bool

Valid returns true if mp has a value.

func (*MultiPoint) Value

func (mp *MultiPoint) Value() (driver.Value, error)

Value returns the EWKB encoding of mp.

type MultiPolygon

type MultiPolygon struct {
	*geom.MultiPolygon
}

A MultiPolygon is a EWKB-encoded MultiPolygon that implements the sql.Scanner and driver.Value interfaces.

func (*MultiPolygon) Scan

func (mp *MultiPolygon) Scan(src interface{}) error

Scan scans from a []byte.

func (*MultiPolygon) Valid

func (mp *MultiPolygon) Valid() bool

Valid returns true if mp has a value.

func (*MultiPolygon) Value

func (mp *MultiPolygon) Value() (driver.Value, error)

Value returns the EWKB encoding of mp.

type Point

type Point struct {
	*geom.Point
}

A Point is a EWKB-encoded Point that implements the sql.Scanner and driver.Value interfaces.

func (*Point) Scan

func (p *Point) Scan(src interface{}) error

Scan scans from a []byte.

func (*Point) Valid

func (p *Point) Valid() bool

Valid returns true if p has a value.

func (*Point) Value

func (p *Point) Value() (driver.Value, error)

Value returns the EWKB encoding of p.

type Polygon

type Polygon struct {
	*geom.Polygon
}

A Polygon is a EWKB-encoded Polygon that implements the sql.Scanner and driver.Value interfaces.

func (*Polygon) Scan

func (p *Polygon) Scan(src interface{}) error

Scan scans from a []byte.

func (*Polygon) Valid

func (p *Polygon) Valid() bool

Valid returns true if p has a value.

func (*Polygon) Value

func (p *Polygon) Value() (driver.Value, error)

Value returns the EWKB encoding of p.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL