geojson

prepare for 1.0.0 release

• BREAKING: Position is now a struct, rather than a type alias for Vec. The new struct uses the tinyvec crate, which allows for faster GeoJSON processing in the common (2-D) case by avoiding per-coordinate heap allocations.

  // BEFORE: Position *was* a Vec. A Vec is always allocated on the heap, which is slow.
  let position: Position = vec![1.0, 2.0];
  let x = position[0];
  
  // AFTER: Position is its own type, buildable *from* a Vec.
  let position: Position = vec![1.0, 2.0].into();
  // index access is unchanged
  let x = position[0];
  
  // Alternatively, you can now construct from an Array, avoiding the Vec's heap allocation.
  let position: Position = [1.0, 2.0].into();
  // equivalently:
  let position = Position::from([1.0, 2.0]);
  
  // You can still build 3D+ Positions. These higher dimension coordinates will use Heap storage.
  let position = Position::from([1.0, 2.0, 3.0]);
  let position = Position::from(vec![1.0, 2.0, 3.0, 4.0, 5.0, 6.0]);
  

  • See https://github.com/georust/geojson/pulls/222
• Substantially speed up parsing (Benches show 30% reduction). This was essentially a rewrite of our deserialization logic. Instead of going from input -> serde_json::JsonObject -> geojson types we now go directly from input -> geojson types.
• Deserialization errors now include line number and column position. Before:

  Encountered neither number type nor string type for 'id' field on 'feature' object: {} After: Error while deserializing GeoJSON: Feature 'id' must be a string or a number at line 3 column 11

• BREAKING: geojson::Error has had many cases removed and some new cases added, reflecting the deserialization rewrite.
• BREAKING: TryInto/From implementations for serde_json::Value and serde_json::Object have been removed now that they are not used for deserialization.
• type is now the first field when serializing GeoJSON objects.
• Since feature.id is optional, we now accept "id: null", whereas previously you were required to omit the id key. Now either is acceptable.
• Fix: Return [] instead of [[]] for POLYGON EMPTY.
  • See https://github.com/georust/geojson/pulls/262
• Potentially breaking: De/Serializing your custom structs with serde now maps your struct's id field to Feature.id, rather than to Feature.properties.id.
• Fix geo_rect_conversion_test to conform to the correctly-wound Polygon output from geo_types::geometry::Rect.to_polygon
  • See https://github.com/georust/geojson/issues/257
• Decreased the size of the Error enum from 200 to 48.
  • See https://github.com/georust/geojson/pulls/260
• geojson::Value has been renamed to geojson::GeometryValue for clarity. The old spelling is still available, but deprecated.
  • See https://github.com/georust/geojson/pull/264
• Add ergonomic constructors to geojson::GeometryValue.

  // BEFORE
  let point = GeometryValue::Point(Position::from([1.0, 2.0]));
  let line_string = GeometryValue::LineString(vec![
    Position::from([1.0, 2.0]),
    Position::from([3.0, 4.0])
  ]);
  let geometry_collection = GeometryValue::GeometryCollection(vec![
    Geometry::new(point),
    Geometry::new(line_string)
  ]);
  
  // AFTER
  let point = GeometryValue::new_point([1.0, 2.0]);
  let line_string = GeometryValue::new_line_string(vec![
    [1.0, 2.0],
    [3.0 4.0]
  ]);
  let geometry_collection = GeometryValue::new_geometry_collection(vec![
    point,
    line_string
  ]);
  

  • See https://github.com/georust/geojson/pull/265
• The geojson::GeometryValue enum variants now have a named field, rather than a newtype.

  let position = Position::from([1,2]);
  
  // before
  let point = geojson::GeometryValue::Point(position);
  let geometry_collection = geojson::GeometryValue::GeometryCollection(vec![point.into()]);
  
  // after
  let point = geojson::GeometryValue::Point { coordinates: position };
  let geometry_collection = geojson::GeometryValue::GeometryCollection { geometries: vec![point.into()] };
  
  // or using the new constructor
  let point = geojson::GeometryValue::new_point(position);
  

• Add to_feature to convert a single S: Serialize to a Feature
• Add from_feature to convert a single Feature to a D: Deserialize
• Upgrade from thiserror v1 to v2
• Add support of serializing optional geo-types with serialize_optional_geometry.
• Add support of deserializing optional geo-types with deserialize_optional_geometry.
• Add support for foreign members to FeatureWriter.
• Added conversion from Vec<Feature> to GeoJson.
• Changed Serialize impls to avoid creating intermediate JsonObjects.
• Better CI: lint, all features
• Implement Default on FeatureCollection.
• Added GeometryCollection::try_from(&GeoJson) and deprecated quick_collection for conventional naming and simpler docs.
  • https://github.com/georust/geojson/pulls/214
• Added GeoJson::to_string_pretty as convenience wrappers around the same serde_json methods.
• The bbox property of a Feature can now be null (returning None) when parsing GeoJSON strings in order to facilitate easier processing of GeoJSON "in the wild" (e.g. Copernicus STAC GeoJSON). The spec does not allow this, but implementations appear to disagree.
  • https://github.com/georust/geojson/pull/252

Prepare for 0.24.1 release

• Modified conversion from JSON to reject zero- and one-dimensional positions.
  • PR: https://github.com/georust/geojson/pull/225

• Added geojson::{ser, de} helpers to convert your custom struct to and from GeoJSON.
  • For external geometry types like geo-types, use the serialize_geometry/deserialize_geometry helpers.
  • Example:

    #[derive(Serialize, Deserialize)]
    struct MyStruct {
        #[serde(serialize_with = "serialize_geometry", deserialize_with = "deserialize_geometry")]
        geometry: geo_types::Point<f64>,
        name: String,
        age: u64,
    }
    
    // read your input
    let my_structs: Vec<MyStruct> = geojson::de::deserialize_feature_collection(geojson_reader).unwrap();
    
    // do some processing
    process(&mut my_structs);
    
    // write back your results
    geojson::ser::to_feature_collection_string(&my_structs).unwrap();
    

  • PR: https://github.com/georust/geojson/pull/199
• Added geojson::{FeatureReader, FeatureWriter} to stream the reading/writing of your custom struct to and from GeoJSON, greatly reducing the memory required to process a FeatureCollection.
  • PR: https://github.com/georust/geojson/pull/199
  • PR: https://github.com/georust/geojson/pull/205
  • PR: https://github.com/georust/geojson/pull/206
• Added IntoIter implementation for FeatureCollection.
  • https://github.com/georust/geojson/pull/196
• Added geojson::Result<T>.
  • https://github.com/georust/geojson/pull/198
• Added TryFrom<&geometry::Value> for geo_type variants.
  • https://github.com/georust/geojson/pull/202
• Changed the Display string of the error produced when converting a geometry to an incompatible type - e.g. a LineString into a Point.
  • https://github.com/georust/geojson/pull/203
• Fix: FeatureIterator errors when reading "features" field before "type" field.
  • https://github.com/georust/geojson/pull/200
• BREAKING: Change the Result type of FeatureIterator from io::Result to crate::Result
  • https://github.com/georust/geojson/pull/199

Prepare for version 0.23.0 release

• Enable optional geo-types integration by default.
  • https://github.com/georust/geojson/pull/189
• FIX: converting a single GeometryCollection Feature to geo_types
  • https://github.com/georust/geojson/pull/194

Prepare for 0.22.4 release

• Allow parsing Feature/FeatureCollection that are missing a "properties" key.
  • https://github.com/georust/geojson/pull/182
• Overhauled front page documentation.
  • https://github.com/georust/geojson/pull/183
• Parse Geometry/Feature/FeatureCollection directly from str rather than via GeoJson when you know what you're expecting.
  • https://github.com/georust/geojson/pull/188
• Feature now derives Default
  • https://github.com/georust/geojson/pull/190
• Reexport JsonObject and JsonValue from serde_json.
  • https://github.com/georust/geojson/pull/191

Prepare for 0.22.3 release

• Added FromIterator<Feature> impl for FeatureCollection
  • https://github.com/georust/geojson/pull/171
• Added 'FeatureIterator streaming feature collection deserializer
  • https://github.com/georust/geojson/pull/181

This is a quick followup release to 0.22.1, which was mistakenly
published by me before updating my local master.

See the 0.22.1 tag (9152be1) for details.

There shouldn't be any problems for users of the interstitial 0.22.1
release, it just has slightly less new features.

• Added convenience methods to convert from geo_types::Geometry directly to GeoJson
  • https://github.com/georust/geojson/pull/164

• Added convenience methods to convert from Geometry and Value to Feature
  • https://github.com/georust/geojson/pull/162

• Update geo-types to 0.7.0

Prepare for 0.21.0 release

• Display implementation of geojson::Value prints` the GeoJSON string
  • https://github.com/georust/geojson/issues/149

• Switch to thiserror
• Add more granular errors
  • GeoJsonUnknownType has been split into NotAFeature and EmptyType
• Add additional Value context to errors where possible
• Add conversions from Geo-Types Line, Triangle, Rect and GeometryCollection

• Update geo-types to 0.6.0
• Remove unnecessary allocations when parsing GeometryCollection
  • https://github.com/georust/geojson/pull/128

• Update geo-types to 0.5.0
• Update docs
• Add quick_collection function
  • https://github.com/georust/geojson/pull/122
• Add TryFrom impls for JsonObject and JsonValue
  • https://github.com/georust/geojson/pull/120
• Add from_json_value! macro
  • https://github.com/georust/geojson/pull/119

• Add TryFrom impls for JsonObject and JsonValue
  • https://github.com/georust/geojson/pull/120
• Add from_json_value for GeoJson enum
  • https://github.com/georust/geojson/pull/119

• Switch to Rust 2018 Edition
  • https://github.com/georust/geojson/pull/111
• Switch to std::TryFrom trait from custom in-crate TryFrom trait
  • https://github.com/georust/geojson/pull/111
• Implement Display for Feature, Geometry, and FeatureCollection
  • https://github.com/georust/geojson/pull/113
  • https://github.com/georust/geojson/pull/114
• Make the geo-types conversion functionality opt-in
  • https://github.com/georust/geojson/pull/115

• Bump geo-types to 0.4.0.
  • https://github.com/georust/geojson/commit/c1681347b4bc49c9085ac3f86fe0488849063913

• Bump geo-types to 0.3.0.
  • https://github.com/georust/geojson/pull/109

• Feature::id should either be a string or number; introduce feature::Id
  • https://github.com/georust/geojson/pull/107
• Fix broken GeoJSON links in docs
  • https://github.com/georust/geojson/pull/105
• Improve error message for mismatched type
  • https://github.com/georust/geojson/commit/1c5d174
• Performance improvements

• Bump geo-types to 0.2.0.
  • https://github.com/georust/geojson/pull/100

• Don't inject empty interior rings when converting to geo Polygons
  • https://github.com/georust/geojson/pull/99

• Switch 'geo' dependency to 'geo-types'
  • https://github.com/georust/geojson/pull/93

• Deserialize Optimizations
  • https://github.com/georust/geojson/pull/82
• Expand docs with parsing examples and corner cases, and enable conversion docs
  • https://github.com/georust/geojson/pull/85
• Update GeoJSON spec links to point to published standard
  • https://github.com/georust/geojson/pull/87
• Bump geo and num-traits crates.
  • https://github.com/georust/geojson/pull/89
• Bump geo dependency: 0.7 -> 0.8.
  • https://github.com/georust/geojson/pull/91

• Don't publicize assert_almost_eq macro
• Bump geo: 0.4 → 0.6
• Use docs.rs for documentation links

• Remove geojson::Crs
• Support foreign_members

• Add missing reference to GeometryCollection

• Upgrade to serde 1.0

• Upgrade rust-geo dep, use num_traits instead of num

• Upgrade to serde 0.9, remove rustc-serialize support, make geo-interop feature mandatory,

• Ability to convert a structure from rust-geojson to rust-geo

• Ability to convert a structure from rust-geo to rust-geojson

• Derive Eq and PartialEq for Error.

• Implement Display instead of ToString for GeoJson.
• Upgrade Serde from 0.7 to 0.8
• Add a few convert::From impls for GeoJson.

• Permit geometry field on feature objects to be null