Merge pull request #124 from georust/kyle/geo-traits-writer

Implement geo-traits for writing to WKT & perf improvement

benches/write.rs

@@ -64,5 +64,31 @@ fn geo_write_wkt(c: &mut criterion::Criterion) {
     });
 }
 
-criterion_group!(benches, wkt_to_string, geo_to_wkt_string, geo_write_wkt);
+fn geo_write_wkt_as_trait(c: &mut criterion::Criterion) {
+    c.bench_function("geo: write small wkt using trait", |bencher| {
+        let s = include_str!("./small.wkt");
+        let w = wkt::Wkt::<f64>::from_str(s).unwrap();
+        let g = geo_types::Geometry::try_from(w).unwrap();
+        bencher.iter(|| {
+            wkt::to_wkt::write_geometry(&mut String::new(), &g).unwrap();
+        });
+    });
+
+    c.bench_function("geo: write big wkt using trait", |bencher| {
+        let s = include_str!("./big.wkt");
+        let w = wkt::Wkt::<f64>::from_str(s).unwrap();
+        let g = geo_types::Geometry::try_from(w).unwrap();
+        bencher.iter(|| {
+            wkt::to_wkt::write_geometry(&mut String::new(), &g).unwrap();
+        });
+    });
+}
+
+criterion_group!(
+    benches,
+    wkt_to_string,
+    geo_to_wkt_string,
+    geo_write_wkt,
+    geo_write_wkt_as_trait
+);
 criterion_main!(benches);

src/error.rs

@@ -0,0 +1,24 @@
+use std::fmt;
+
+use thiserror::Error;
+
+/// Generic errors for WKT writing and reading
+#[derive(Error, Debug)]
+pub enum Error {
+    #[error("Only 2D input is supported when writing Rect to WKT.")]
+    RectUnsupportedDimension,
+    #[error("Only defined dimensions and undefined dimensions of 2, 3, or 4 are supported.")]
+    UnknownDimension,
+    /// Wrapper around `[std::fmt::Error]`
+    #[error(transparent)]
+    FmtError(#[from] std::fmt::Error),
+}
+
+impl From<Error> for fmt::Error {
+    fn from(value: Error) -> Self {
+        match value {
+            Error::FmtError(err) => err,
+            _ => std::fmt::Error,
+        }
+    }
+}

src/lib.rs

@@ -86,15 +86,18 @@ use geo_traits::{
 };
 use num_traits::{Float, Num, NumCast};
 
+use crate::to_wkt::write_geometry;
 use crate::tokenizer::{PeekableTokens, Token, Tokens};
 use crate::types::{
     Dimension, GeometryCollection, LineString, MultiLineString, MultiPoint, MultiPolygon, Point,
     Polygon,
 };
 
-mod to_wkt;
+pub mod to_wkt;
 mod tokenizer;
 
+/// Error variant for this crate
+pub mod error;
 /// `WKT` primitive types and collections
 pub mod types;
 
@@ -105,8 +108,6 @@ pub use infer_type::infer_type;
 #[cfg(feature = "geo-types")]
 extern crate geo_types;
 
-extern crate thiserror;
-
 pub use crate::to_wkt::ToWkt;
 
 #[cfg(feature = "geo-types")]
@@ -359,15 +360,7 @@ where
     T: WktNum + fmt::Display,
 {
     fn fmt(&self, f: &mut fmt::Formatter) -> Result<(), fmt::Error> {
-        match self {
-            Wkt::Point(point) => point.fmt(f),
-            Wkt::LineString(linestring) => linestring.fmt(f),
-            Wkt::Polygon(polygon) => polygon.fmt(f),
-            Wkt::MultiPoint(multipoint) => multipoint.fmt(f),
-            Wkt::MultiLineString(multilinstring) => multilinstring.fmt(f),
-            Wkt::MultiPolygon(multipolygon) => multipolygon.fmt(f),
-            Wkt::GeometryCollection(geometrycollection) => geometrycollection.fmt(f),
-        }
+        Ok(write_geometry(f, self)?)
     }
 }