Enum geo_types::Geometry

pub enum Geometry<T> where
    T: CoordNum,  {
    Point(Point<T>),
    Line(Line<T>),
    LineString(LineString<T>),
    Polygon(Polygon<T>),
    MultiPoint(MultiPoint<T>),
    MultiLineString(MultiLineString<T>),
    MultiPolygon(MultiPolygon<T>),
    GeometryCollection(GeometryCollection<T>),
    Rect(Rect<T>),
    Triangle(Triangle<T>),
}

An enum representing any possible geometry type.

All Geo types can be converted to a Geometry member using .into() (as part of the std::convert::Into pattern), and Geo types implement the TryFrom trait in order to convert back from enum members.

Example

use std::convert::TryFrom;
use geo_types::{Point, point, Geometry, GeometryCollection};
let p = point!(x: 1.0, y: 1.0);
let pe: Geometry<f64> = p.into();
let pn = Point::try_from(pe).unwrap();

Variants

Point(Point<T>)

Tuple Fields

0: Point<T>

Line(Line<T>)

Tuple Fields

0: Line<T>

LineString(LineString<T>)

Tuple Fields

0: LineString<T>

Polygon(Polygon<T>)

Tuple Fields

0: Polygon<T>

MultiPoint(MultiPoint<T>)

Tuple Fields

0: MultiPoint<T>

MultiLineString(MultiLineString<T>)

Tuple Fields

0: MultiLineString<T>

MultiPolygon(MultiPolygon<T>)

Tuple Fields

0: MultiPolygon<T>

GeometryCollection(GeometryCollection<T>)

Tuple Fields

0: GeometryCollection<T>

Rect(Rect<T>)

Tuple Fields

0: Rect<T>

Triangle(Triangle<T>)

Tuple Fields

0: Triangle<T>

Implementations

impl<T: CoordNum> Geometry<T>

pub fn into_point(self) -> Option<Point<T>>

👎 Deprecated:

Will be removed in an upcoming version. Switch to std::convert::TryInto<Point>

If this Geometry is a Point, then return that, else None.

Examples

use geo_types::*;
let g = Geometry::Point(Point::new(0., 0.));
let p2: Point<f32> = g.into_point().unwrap();
assert_eq!(p2, Point::new(0., 0.,));

pub fn into_line_string(self) -> Option<LineString<T>>

👎 Deprecated:

Will be removed in an upcoming version. Switch to std::convert::TryInto<LineString>

If this Geometry is a LineString, then return that LineString, else None.

pub fn into_line(self) -> Option<Line<T>>

👎 Deprecated:

Will be removed in an upcoming version. Switch to std::convert::TryInto<Line>

If this Geometry is a Line, then return that Line, else None.

pub fn into_polygon(self) -> Option<Polygon<T>>

👎 Deprecated:

Will be removed in an upcoming version. Switch to std::convert::TryInto<Polygon>

If this Geometry is a Polygon, then return that, else None.

pub fn into_multi_point(self) -> Option<MultiPoint<T>>

👎 Deprecated:

Will be removed in an upcoming version. Switch to std::convert::TryInto<MultiPoint>

If this Geometry is a MultiPoint, then return that, else None.

pub fn into_multi_line_string(self) -> Option<MultiLineString<T>>

👎 Deprecated:

Will be removed in an upcoming version. Switch to std::convert::TryInto<MultiLineString>

If this Geometry is a MultiLineString, then return that, else None.

pub fn into_multi_polygon(self) -> Option<MultiPolygon<T>>

👎 Deprecated:

Will be removed in an upcoming version. Switch to std::convert::TryInto<MultiPolygon>

If this Geometry is a MultiPolygon, then return that, else None.

Trait Implementations

impl<T: AbsDiffEq<Epsilon = T> + CoordNum> AbsDiffEq<Geometry<T>> for Geometry<T>

fn abs_diff_eq(&self, other: &Self, epsilon: Self::Epsilon) -> bool

Equality assertion with an absolute limit.

Examples

use geo_types::{Geometry, polygon};

let a: Geometry<f32> = polygon![(x: 0., y: 0.), (x: 5., y: 0.), (x: 7., y: 9.), (x: 0., y: 0.)].into();
let b: Geometry<f32> = polygon![(x: 0., y: 0.), (x: 5., y: 0.), (x: 7.01, y: 9.), (x: 0., y: 0.)].into();

approx::assert_abs_diff_eq!(a, b, epsilon=0.1);
approx::assert_abs_diff_ne!(a, b, epsilon=0.001);

type Epsilon = T

Used for specifying relative comparisons.

fn default_epsilon() -> Self::Epsilon

The default tolerance to use when testing values that are close together.

fn abs_diff_ne(&self, other: &Rhs, epsilon: Self::Epsilon) -> bool

The inverse of AbsDiffEq::abs_diff_eq.

impl<T: Clone> Clone for Geometry<T> where
    T: CoordNum, 

fn clone(&self) -> Geometry<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Geometry<T> where
    T: CoordNum, 

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

Formats the value using the given formatter.

impl<T: CoordNum> From<Line<T>> for Geometry<T>

fn from(x: Line<T>) -> Geometry<T>

Performs the conversion.

impl<T: CoordNum> From<LineString<T>> for Geometry<T>

fn from(x: LineString<T>) -> Geometry<T>

Performs the conversion.

impl<T: CoordNum> From<MultiLineString<T>> for Geometry<T>

fn from(x: MultiLineString<T>) -> Geometry<T>

Performs the conversion.

impl<T: CoordNum> From<MultiPoint<T>> for Geometry<T>

fn from(x: MultiPoint<T>) -> Geometry<T>

Performs the conversion.

impl<T: CoordNum> From<MultiPolygon<T>> for Geometry<T>

fn from(x: MultiPolygon<T>) -> Geometry<T>

Performs the conversion.

impl<T: CoordNum> From<Point<T>> for Geometry<T>

fn from(x: Point<T>) -> Geometry<T>

Performs the conversion.

impl<T: CoordNum> From<Polygon<T>> for Geometry<T>

fn from(x: Polygon<T>) -> Geometry<T>

Performs the conversion.

impl<T: CoordNum> From<Rect<T>> for Geometry<T>

fn from(x: Rect<T>) -> Geometry<T>

Performs the conversion.

impl<T: CoordNum> From<Triangle<T>> for Geometry<T>

fn from(x: Triangle<T>) -> Geometry<T>

Performs the conversion.

impl<T: Hash> Hash for Geometry<T> where
    T: CoordNum, 

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<T: PartialEq> PartialEq<Geometry<T>> for Geometry<T> where
    T: CoordNum, 

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

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Geometry<T>) -> bool

This method tests for !=.

impl<T> RelativeEq<Geometry<T>> for Geometry<T> where
    T: AbsDiffEq<Epsilon = T> + CoordNum + RelativeEq, 

fn relative_eq(
    &self,
    other: &Self,
    epsilon: Self::Epsilon,
    max_relative: Self::Epsilon
) -> bool

Equality assertion within a relative limit.

Examples

use geo_types::{Geometry, polygon};

let a: Geometry<f32> = polygon![(x: 0., y: 0.), (x: 5., y: 0.), (x: 7., y: 9.), (x: 0., y: 0.)].into();
let b: Geometry<f32> = polygon![(x: 0., y: 0.), (x: 5., y: 0.), (x: 7.01, y: 9.), (x: 0., y: 0.)].into();

approx::assert_relative_eq!(a, b, max_relative=0.1);
approx::assert_relative_ne!(a, b, max_relative=0.001);

fn default_max_relative() -> Self::Epsilon

The default relative tolerance for testing values that are far-apart.

fn relative_ne(
    &self,
    other: &Rhs,
    epsilon: Self::Epsilon,
    max_relative: Self::Epsilon
) -> bool

The inverse of RelativeEq::relative_eq.

impl<T: CoordNum> TryFrom<Geometry<T>> for Point<T>

Convert a Geometry enum into its inner type.

Fails if the enum case does not match the type you are trying to convert it to.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(geom: Geometry<T>) -> Result<Self, Self::Error>

Performs the conversion.

impl<T: CoordNum> TryFrom<Geometry<T>> for Line<T>

Convert a Geometry enum into its inner type.

Fails if the enum case does not match the type you are trying to convert it to.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(geom: Geometry<T>) -> Result<Self, Self::Error>

Performs the conversion.

impl<T: CoordNum> TryFrom<Geometry<T>> for LineString<T>

Convert a Geometry enum into its inner type.

Fails if the enum case does not match the type you are trying to convert it to.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(geom: Geometry<T>) -> Result<Self, Self::Error>

Performs the conversion.

impl<T: CoordNum> TryFrom<Geometry<T>> for Polygon<T>

Convert a Geometry enum into its inner type.

Fails if the enum case does not match the type you are trying to convert it to.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(geom: Geometry<T>) -> Result<Self, Self::Error>

Performs the conversion.

impl<T: CoordNum> TryFrom<Geometry<T>> for MultiPoint<T>

Convert a Geometry enum into its inner type.

Fails if the enum case does not match the type you are trying to convert it to.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(geom: Geometry<T>) -> Result<Self, Self::Error>

Performs the conversion.

impl<T: CoordNum> TryFrom<Geometry<T>> for MultiLineString<T>

Convert a Geometry enum into its inner type.

Fails if the enum case does not match the type you are trying to convert it to.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(geom: Geometry<T>) -> Result<Self, Self::Error>

Performs the conversion.

impl<T: CoordNum> TryFrom<Geometry<T>> for MultiPolygon<T>

Convert a Geometry enum into its inner type.

Fails if the enum case does not match the type you are trying to convert it to.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(geom: Geometry<T>) -> Result<Self, Self::Error>

Performs the conversion.

impl<T: CoordNum> TryFrom<Geometry<T>> for Rect<T>

Convert a Geometry enum into its inner type.

Fails if the enum case does not match the type you are trying to convert it to.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(geom: Geometry<T>) -> Result<Self, Self::Error>

Performs the conversion.

impl<T: CoordNum> TryFrom<Geometry<T>> for Triangle<T>

Convert a Geometry enum into its inner type.

Fails if the enum case does not match the type you are trying to convert it to.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(geom: Geometry<T>) -> Result<Self, Self::Error>

Performs the conversion.

impl<T: Eq> Eq for Geometry<T> where
    T: CoordNum, 

impl<T> StructuralEq for Geometry<T> where
    T: CoordNum, 

impl<T> StructuralPartialEq for Geometry<T> where
    T: CoordNum,