Crate s2json

Source

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
BaseGeometry
BaseGeometry is the a generic geometry type
Feature
Component to build an WG Feature
FeatureCollection
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
PointOrPoint3D
Define a Point or Point3D
S2FeatureCollection
S2 FeatureCollection
STPoint
A Point in S2 Space with a Face
VectorBaseGeometry
BaseGeometry is the a generic geometry type
VectorFeature
Component to build an WG or S2 Vector Feature
VectorPoint
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
FeatureCollectionType
FeatureCollection type string
FeatureCollections
Either an S2 or WG FeatureCollection
FeatureType
Feature type string
Features
Either an S2, Vector WG or WG Feature
Geometry
All possible geometry shapes
GeometryType
Enum to represent specific geometry types as strings
JSONCollection
All major S2JSON types
JSONValue
All possible JSON shapes
MValues
All possible M-Value shapes
PrimitiveShape
Primitive types that can be found in a shape
PrimitiveShapeType
Arrays may contain either a primitive or an object whose values are primitives
PrimitiveValue
Primitive types supported by Properties
Projection
All projections that can be used
S2FeatureCollectionType
FeatureCollection type string
ShapeType
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
ValuePrimitiveType
Arrays may contain either a primitive or an object whose values are primitives
ValueType
Supports primitive types string, number, boolean, null May 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.
VectorFeatureType
Feature type string
VectorGeometry
All possible geometry shapes
VectorGeometryType
Enum to represent specific vector geometry types as strings
VectorOffsets
All possible geometry offsets

Traits§

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
JSONPropertiesCompatible
Ensure M implements MValueCompatible
MValueCompatible
Ensure M implements MValueCompatible

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” }
JSONProperties
Shape of an un-restricted features properties object
LineString
Definition of a LineString
LineString3D
Definition of a 3D LineString
LineString3DGeometry
LineString3DGeometry is a 3D line
LineStringGeometry
LineStringGeometry is a line
LineStringMValues
LineString Properties Shape
MValue
Shape of a feature’s M-Values object
MapboxProperties
Shape of the restricted Mapbox properties object
MultiLineString
Definition of a MultiLineString
MultiLineString3D
Definition of a 3D MultiLineString
MultiLineString3DGeometry
MultiLineString3DGeometry contains multiple 3D lines
MultiLineStringGeometry
MultiLineStringGeometry contains multiple lines
MultiLineStringMValues
MultiLineString MValues Shape
MultiPoint
Definition of a MultiPoint
MultiPoint3D
Definition of a 3D MultiPoint
MultiPoint3DGeometry
MultiPoint3DGeometry contains multiple 3D points
MultiPointGeometry
MultiPointGeometry contains multiple points
MultiPolygon
Definition of a MultiPolygon
MultiPolygon3D
Definition of a 3D MultiPolygon
MultiPolygon3DGeometry
MultiPolygon3DGeometry is a 3D polygon with multiple polygons with their own potential holes
MultiPolygonGeometry
MultiPolygonGeometry is a polygon with multiple polygons with their own potential holes
MultiPolygonMValues
MultiPolygon MValues Shape
Point3DGeometry
Point3DGeometry is a 3D point
PointGeometry
PointGeometry is a point
Polygon
Definition of a Polygon
Polygon3D
Definition of a 3D Polygon
Polygon3DGeometry
Polygon3DGeometry is a 3D polygon with potential holes
PolygonGeometry
PolygonGeometry is a polygon with potential holes
PolygonMValues
Polygon MValues Shape
Properties
Shape of a features properties object
Shape
The Shape Object
ShapePrimitive
The Primitive Shape Object
Value
Shape design
ValuePrimitive
Shape of a ValuePrimitiveType Nested object
VectorLineOffset
An offset defines how far the starting line is from the original starting point pre-slice
VectorLineString
Definition of a Vector LineString
VectorLineStringGeometry
LineStringGeometry is a line
VectorMultiLineOffset
A collection of offsets
VectorMultiLineString
Definition of a Vector MultiLineString
VectorMultiLineStringGeometry
MultiLineStringGeometry contains multiple lines
VectorMultiPoint
Definition of a Vector MultiPoint
VectorMultiPointGeometry
MultiPointGeometry contains multiple points
VectorMultiPolygon
Definition of a Vector MultiPolygon
VectorMultiPolygonGeometry
MultiPolygonGeometry is a polygon with multiple polygons with their own potential holes
VectorMultiPolygonOffset
A collection of collections of offsets
VectorPointGeometry
PointGeometry is a point
VectorPolygon
Definition of a Vector Polygon
VectorPolygonGeometry
PolygonGeometry is a polygon with potential holes
VectorPolygonOffset
A collection of offsets

Derive Macros§

JSONProperties
Derives the JSONProperties trait for a struct to convert it to a JSONProperties.
MValue
Derives the MValue trait for a struct to convert it to a MValue.
MValueCompatible
Derives the MValueCompatible trait for a struct to convert it to a MValue.
Properties
Derives the Properties trait for a struct to convert it to a Properties.
ValuePrimitive