Struct Geometry 

pub struct Geometry {
    pub bbox: Option<Vec<f64>>,
    pub value: GeometryValue,
    pub foreign_members: Option<Map<String, Value>>,
}

Geometry Object

GeoJSON Format Specification § 3.1

Examples

Constructing a Geometry (the long way):

use geojson::{Geometry, GeometryValue, Position};

let geometry = Geometry {
    // `value` corresponds to the 'type' and 'coordinates' field.
    value: GeometryValue::Point {
        coordinates: Position::from([7.428959, 1.513394]),
    },
    bbox: None,
    foreign_members: None,
};

Constructors make this more concise.

let geometry = Geometry::new_point([1.23, 3.45]);

Serializing a Geometry to a GeoJSON string:

use geojson::Geometry;

let geometry = Geometry::new_point([1.23, 3.45]);

let geojson_string = geometry.to_string();
assert_eq!(
    geojson_string,
    r#"{"type":"Point","coordinates":[1.23,3.45]}"#
);

Deserializing a GeoJSON string into a Geometry:

use geojson::Geometry;

let geojson_str = r#"{"type":"Point", "coordinates":[7.428959,1.513394]}"#;

let geometry = geojson_str
    .parse::<Geometry>()
    .expect("valid Geometry GeoJSON");

assert_eq!(Geometry::new_point([7.428959, 1.513394]), geometry,);

Transforming a Geometry into a geo_types::Point<f64> (which requires the geo-types feature):

use geojson::Geometry;
use std::convert::TryInto;

let geometry = Geometry::new_point([1.23, 4.56]);
let geom: geo_types::Point = geometry.try_into().unwrap();
assert_eq!(geom.x(), 1.23);
assert_eq!(geom.y(), 4.56);

Fields

bbox: Option<Vec<f64>>

Bounding Box

GeoJSON Format Specification § 5

value: GeometryValue

foreign_members: Option<Map<String, Value>>

Foreign Members

GeoJSON Format Specification § 6

See the crate-level foreign members documentation for details, including limitations on key names.

Implementations

impl Geometry

pub fn new(value: GeometryValue) -> Geometry

Returns a new Geometry with the specified value. bbox and foreign_members will be set to None.

pub fn new_point(value: impl Into<Position>) -> Geometry

pub fn new_line_string( value: impl IntoIterator<Item = impl Into<Position>>, ) -> Geometry

pub fn new_multi_point( value: impl IntoIterator<Item = impl Into<Position>>, ) -> Geometry

pub fn new_multi_line_string( value: impl IntoIterator<Item = impl IntoIterator<Item = impl Into<Position>>>, ) -> Geometry

pub fn new_polygon( value: impl IntoIterator<Item = impl IntoIterator<Item = impl Into<Position>>>, ) -> Geometry

pub fn new_multi_polygon( value: impl IntoIterator<Item = impl IntoIterator<Item = impl IntoIterator<Item = impl Into<Position>>>>, ) -> Geometry

pub fn new_geometry_collection( value: impl IntoIterator<Item = impl Into<Geometry>>, ) -> Geometry

Trait Implementations

impl Clone for Geometry

fn clone(&self) -> Geometry

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Geometry

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Geometry

fn deserialize<__D>( __deserializer: __D, ) -> Result<Geometry, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Geometry

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<V> From<V> for Geometry

where V: Into<GeometryValue>,

fn from(v: V) -> Geometry

Converts to this type from the input type.

impl FromStr for Geometry

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Geometry, Error>

Parses a string s to return a value of this type.

impl PartialEq for Geometry

fn eq(&self, other: &Geometry) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Geometry

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Geometry

impl TryFrom<GeoJson> for Geometry

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: GeoJson) -> Result<Geometry, Error>

Performs the conversion.

impl TryFrom<RawGeometry> for Geometry

type Error = Error

The type returned in the event of a conversion error.

fn try_from(raw: RawGeometry) -> Result<Geometry, Error>

Performs the conversion.