Add a general Marshal and Unmarshal function to geojson package. #113
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Pull Request Test Coverage Report for Build 514
💛 - Coveralls |
gdey
commented
Jan 20, 2021
| // mapping between JSON and geom Geometry values are described in | ||
| // the documentation for the Marshal and Unmarshal functions. | ||
| // | ||
| // At current this pacakge only supports 2D Geometries unless stated |
There was a problem hiding this comment.
package is misspelled as 'pacakge'
There was a problem hiding this comment.
also, change 'stated otherwise' to 'otherwise stated'
|
LGTM. No need to include extended geometries since they are not include in the GeoJSON standard. |
* Added additional information about package to main README.md file.
* Documented the errors and rearranged code for error.go to make it
easier to read the code.
* Added pacakge documentation with references to appropriate RFC. * Improved documentation for methods.
* Added a general Marshal function to the geojson package to make using the package easier. Currently you have to write a geom Geometry object with a geojson Geometry object and then a Feature object. This is ugly. The new Marshal function will take care of the wrapping as needed. * Added a general MarshalIndent function that behaves like Marshal, but returns and indented version of the geojson.
* Add an Unmarshal function to the top level of geojson, to allow simpler unmarshalling of geojson Features and FeatureCollections.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The current way of using the
geojsonpackage requires one to wrap a geometry several times.This PR introduces three new methods to simplify using the package.
Marshal-- which will take any geom.Geometry, or slice of geom.Geometries, or ageojson.Feature, or ageojson.FeatureCollectionand return ageojsonencoded version of it, or an error.MarshalIndentis the same as Marshal, returning a pretty version of the output insteadUnmarshalwhich will take an encodedgeojsonbyte slice, and return either ageojson.Feature, or ageojson.FeatureCollection.@gbroccolo could you give this a review as well. Thank you.