RFC: API improvements

[pka]

The geometry processing API has worked well for different implementations, so there are no short term changes planned. Mid term improvements:

• Pass SRID to processor
• More ergonomic processor configuration (currently via dimensions())

There is a initial high-level Reader API and Writer API, covering basic file reading/writing. The current core Reader/Writer implementations have the following Structs for writing and functions for reading:

• GeoJsonWriter: GeoJSON writer
• read_geojson: Read and process GeoJSON feature
• read_geojson_geom: Read and process GeoJSON geometry
• Geos: Generator for GEOS geometry type
• process_geos: Process GEOS geometry
• RustGeo: Generator for georust/geo geometry type
• SvgWriter: SVG writer
• Wkt: WKT writer

flatgeobuf:

• FgbReader: FlatGeobuf dataset reader
• HttpFgbReader: FlatGeobuf dataset HTTP reader

Code examples:

let mut geos = Geos::new();
read_geojson(geojson.as_bytes(), &mut geos);

let mut fgb = FgbReader::open(&mut filein)?;
fgb.select_bbox(8.8, 47.2, 9.5, 55.3)?;
let mut json = GeoJsonWriter::new(&mut fout);
fgb.process_features(&mut json)

These struct/functions should be named more uniformly. Proposal:

• FooWriter: Struct for writing format Foo. (Alternatives: Foo, FooSink, FooProducer, foo::Writer)
• FooReader: Struct for reading format Foo. (Alternatives: FooSource, FooConsumer, foo::Reader)
• FooReader.process_features: Read and process all selected features
• foo::process: Function for processing (reading) feature of format Foo
• foo:process_geom: Function for processing (reading) geometry of format Foo

Code examples:

let mut out = GeosWriter::new();
geojson::process(geojson.as_bytes(), &mut out);

Feedback welcome! @georust ?

[pka]

Version 0.5.0

Writer structs:

• gdal::GdalWriter: GDAL
• geojson::GeoJsonWriter: GeoJSON
• geos::Geos: GEOS
• geo_types::Geo: geo-types
• svg::SvgWriter: SVG
• wkb::WkbWriter: WKB
• wkt::WktWriter: WKT

Structs for DB type encoding/decoding:

• gpkg::geo::Geometry: Geopackage / geo-types
• gpkg::geos::Geometry: Geopackage / GEOS
• postgis::postgres::geo::Geometry: PostGIS rust-postgres / geo-types
• postgis::postgres::geos::Geometry: PostGIS rust-postgres / GEOS
• postgis::sqlx::geo::Geometry: PostGIS SQLx / geo-types
• postgis::sqlx::geos::Geometry: PostGIS SQLx / GEOS

Reader functions:

• gdal::process_geom: GDAL
• geojson::read_geojson: GeoJSON feature (incl. geometry)
• geojson::read_geojson_geom: GeoJSON geometry
• geos::process_geos: GEOS
• wkb::process_ewkb_geom: PostGIS EWKB
• wkb::process_gpkg_geom: Geopackage WKB

[pka]

Version 0.7.0

Conversion:	Format	GeozeroGeometry	GeozeroDatasource	GeomProcessor	Geometry Conversion
geo-types	geo_types::Geometry<f64>	-	geo_types::GeoWriter	ToGeo
GeoJSON	GeoJson	GeoJsonReader, GeoJson	geojson::GeoJsonWriter	ToJson
GDAL	gdal::vector::Geometry	-	gdal::GdalWriter	ToGdal
GEOS	geos::Geometry	-	geos::GeosWriter	ToGeos
SVG	-	-	svg::SvgWriter	ToSvg
WKB	Wkb, Ewkb, GpkgWkb	-	wkb::WkbWriter	ToWkb
WKT	-	-	wkt::WktWriter	ToWkt
FlatGeobuf	FgbFeature	FgbReader	-	-

Structs for DB type encoding/decoding:

• wkb::Geometry<T: GeozeroGeometry>

Reader functions:

• gdal::process_geom: GDAL
• geojson::read_geojson: GeoJSON feature (incl. geometry)
• geojson::read_geojson_geom: GeoJSON geometry
• geos::process_geom: GEOS
• wkb::process_ewkb_geom: PostGIS EWKB
• wkb::process_gpkg_geom: Geopackage WKB