Expand description
The s2json Rust crate provides functionalities to read and write S2JSON Spec data structures.
This crate is a 0 dependency package that uses no_std and is intended to be used in
embedded systems and WASM applications.
NOTE: WG stands for WGS84 and S2 stands for S2Geometry
Modules§
- geometry
- All geometry types and structs
- impls
- All json, value, shape impl
- map
- BTreeMap wrapper
- shape
- All shape types and structs
- value
- All values types and structs
Structs§
- BBox
- A BBOX is defined in lon-lat space and helps with zooming motion to see the entire line or polygon The order is (left, bottom, right, top) If WM, then the projection is lon-lat If S2, then the projection is s-t
- BBox3D
- A BBOX is defined in lon-lat space and helps with zooming motion to see the entire 3D line or polygon
- Base
Geometry - BaseGeometry is the a generic geometry type
- Feature
- Component to build an WG Feature
- Feature
Collection - WG FeatureCollection
- Map
- A BTreeMap wrapper
- Point
- Definition of a Point. May represent WebMercator Lon-Lat or S2Geometry S-T
- Point3D
- Definition of a 3D Point. May represent WebMercator Lon-Lat or S2Geometry S-T with a z-value
- Point
OrPoint3D - Define a Point or Point3D
- S2Feature
Collection - S2 FeatureCollection
- STPoint
- A Point in S2 Space with a Face
- Vector
Base Geometry - BaseGeometry is the a generic geometry type
- Vector
Feature - Component to build an WG or S2 Vector Feature
- Vector
Point - A Vector Point uses a structure for 2D or 3D points
Enums§
- Axis
- The axis to apply an operation to
- BBOX
- BBox or BBox3D
- Face
- Cube-face on the S2 sphere
- Feature
Collection Type - FeatureCollection type string
- Feature
Collections - Either an S2 or WG FeatureCollection
- Feature
Type - Feature type string
- Features
- Either an S2, Vector WG or WG Feature
- Geometry
- All possible geometry shapes
- Geometry
Type - Enum to represent specific geometry types as strings
- JSON
Collection - All major S2JSON types
- JSON
Value - All possible JSON shapes
- MValues
- All possible M-Value shapes
- Primitive
Shape - Primitive types that can be found in a shape
- Primitive
Shape Type - Arrays may contain either a primitive or an object whose values are primitives
- Primitive
Value - Primitive types supported by Properties
- Projection
- All projections that can be used
- S2Feature
Collection Type - FeatureCollection type string
- Shape
Type - Shape types that can be found in a shapes object. Either a primitive, an array containing any type, or a nested shape. If the type is an array, all elements must be the same type
- Value
Primitive Type - Arrays may contain either a primitive or an object whose values are primitives
- Value
Type - Supports primitive types
string,number,boolean,nullMay be an array of those primitive types, or an object whose values are only primitives Object keys are always strings, values can be any basic type, an array, or a nested object. Array values must all be the same type. - Vector
Feature Type - Feature type string
- Vector
Geometry - All possible geometry shapes
- Vector
Geometry Type - Enum to represent specific vector geometry types as strings
- Vector
Offsets - All possible geometry offsets
Traits§
- FullXY
- Composite Trait for XY use cases
- FullXYZ
- Composite Trait for XYZ use cases
- FullXYZM
- Composite Trait for XYZM use cases
- GetM
- Trait to extract the m value
- GetXY
- Trait to extract the x and y values
- GetXYM
- Composite Trait: XY + M
- GetXYZ
- Composite Trait: XY + Z
- GetXYZM
- Composite Trait: XY + Z + M
- GetZ
- Trait to extract the z value
- JSON
Properties Compatible - Ensure M implements MValueCompatible
- MValue
Compatible - Ensure M implements MValueCompatible
- NewXY
- Trait to create a new XY
- NewXYZ
- Trait to create a new XYZ
- NewXYZM
- Trait to create a new XYZM
- SetM
- Trait to set the m value
- SetXY
- Trait to set the x and y values
- SetXYM
- Composite Trait: XY + M
- SetXYZ
- Composite Trait: XY + Z
- SetXYZM
- Composite Trait: XY + Z + M
- SetZ
- Trait to set the z value
Type Aliases§
- Attributions
- Attribution data is stored in an object. The key is the name of the attribution, and the value is the href link e.g. { “Open S2”: “https://opens2.com/legal/data” }
- JSON
Properties - Shape of an un-restricted features properties object
- Line
String - Definition of a LineString
- Line
String3D - Definition of a 3D LineString
- Line
String3D Geometry - LineString3DGeometry is a 3D line
- Line
String Geometry - LineStringGeometry is a line
- Line
StringM Values - LineString Properties Shape
- MValue
- Shape of a feature’s M-Values object
- Mapbox
Properties - Shape of the restricted Mapbox properties object
- Multi
Line String - Definition of a MultiLineString
- Multi
Line String3D - Definition of a 3D MultiLineString
- Multi
Line String3D Geometry - MultiLineString3DGeometry contains multiple 3D lines
- Multi
Line String Geometry - MultiLineStringGeometry contains multiple lines
- Multi
Line StringM Values - MultiLineString MValues Shape
- Multi
Point - Definition of a MultiPoint
- Multi
Point3D - Definition of a 3D MultiPoint
- Multi
Point3D Geometry - MultiPoint3DGeometry contains multiple 3D points
- Multi
Point Geometry - MultiPointGeometry contains multiple points
- Multi
Polygon - Definition of a MultiPolygon
- Multi
Polygon3D - Definition of a 3D MultiPolygon
- Multi
Polygon3D Geometry - MultiPolygon3DGeometry is a 3D polygon with multiple polygons with their own potential holes
- Multi
Polygon Geometry - MultiPolygonGeometry is a polygon with multiple polygons with their own potential holes
- Multi
PolygonM Values - MultiPolygon MValues Shape
- Point3D
Geometry - Point3DGeometry is a 3D point
- Point
Geometry - PointGeometry is a point
- Polygon
- Definition of a Polygon
- Polygon3D
- Definition of a 3D Polygon
- Polygon3D
Geometry - Polygon3DGeometry is a 3D polygon with potential holes
- Polygon
Geometry - PolygonGeometry is a polygon with potential holes
- PolygonM
Values - Polygon MValues Shape
- Properties
- Shape of a features properties object
- Shape
- The Shape Object
- Shape
Primitive - The Primitive Shape Object
- Value
- Shape design
- Value
Primitive - Shape of a ValuePrimitiveType Nested object
- Vector
Line Offset - An offset defines how far the starting line is from the original starting point pre-slice
- Vector
Line String - Definition of a Vector LineString
- Vector
Line String Geometry - LineStringGeometry is a line
- Vector
Multi Line Offset - A collection of offsets
- Vector
Multi Line String - Definition of a Vector MultiLineString
- Vector
Multi Line String Geometry - MultiLineStringGeometry contains multiple lines
- Vector
Multi Point - Definition of a Vector MultiPoint
- Vector
Multi Point Geometry - MultiPointGeometry contains multiple points
- Vector
Multi Polygon - Definition of a Vector MultiPolygon
- Vector
Multi Polygon Geometry - MultiPolygonGeometry is a polygon with multiple polygons with their own potential holes
- Vector
Multi Polygon Offset - A collection of collections of offsets
- Vector
Point Geometry - PointGeometry is a point
- Vector
Polygon - Definition of a Vector Polygon
- Vector
Polygon Geometry - PolygonGeometry is a polygon with potential holes
- Vector
Polygon Offset - A collection of offsets
Derive Macros§
- JSON
Properties derive - Derives the
JSONPropertiestrait for a struct to convert it to aJSONProperties. - MValue
derive - Derives the
MValuetrait for a struct to convert it to aMValue. - MValue
Compatible derive - Derives the
MValueCompatibletrait for a struct to convert it to aMValue. - Properties
derive - Derives the
Propertiestrait for a struct to convert it to aProperties. - Value
Primitive derive - Derives the
ValuePrimitivetrait for a struct to convert it to aValuePrimitive.