Enum geo::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>)

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>)

Implementations

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

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<Geometry<T>> for Geometry<T> where
    T: AbsDiffEq<T, Epsilon = T> + CoordNum, 

type Epsilon = T

Used for specifying relative comparisons.

pub fn default_epsilon() -> <Geometry<T> as AbsDiffEq<Geometry<T>>>::Epsilon

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

pub fn abs_diff_eq(
    &self,
    other: &Geometry<T>,
    epsilon: <Geometry<T> as AbsDiffEq<Geometry<T>>>::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);

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

The inverse of [AbsDiffEq::abs_diff_eq].

impl<T> Area<T> for Geometry<T> where
    T: CoordFloat, 

fn signed_area(&self) -> T

fn unsigned_area(&self) -> T

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

type Output = Option<Rect<T>>

fn bounding_rect(&self) -> Self::Output

Return the bounding rectangle of a geometry

impl<T> Centroid for Geometry<T> where
    T: GeoFloat, 

type Output = Option<Point<T>>

fn centroid(&self) -> Self::Output

See: https://en.wikipedia.org/wiki/Centroid

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Contains<Coordinate<T>> for Geometry<T> where
    T: GeoNum, 

fn contains(&self, coord: &Coordinate<T>) -> bool

impl<T> Contains<Point<T>> for Geometry<T> where
    T: GeoNum, 

fn contains(&self, point: &Point<T>) -> bool

impl<T> CoordinatePosition for Geometry<T> where
    T: GeoNum, 

type Scalar = T

fn calculate_coordinate_position(
    &self,
    coord: &Coordinate<T>,
    is_inside: &mut bool,
    boundary_count: &mut usize
)

fn coordinate_position(&self, coord: &Coordinate<Self::Scalar>) -> CoordPos

impl<'a, T: CoordNum + 'a> CoordsIter<'a> for Geometry<T>

type Iter = GeometryCoordsIter<'a, T>

type ExteriorIter = GeometryExteriorCoordsIter<'a, T>

type Scalar = T

fn coords_iter(&'a self) -> Self::Iter

Iterate over all exterior and (if any) interior coordinates of a geometry.

fn coords_count(&'a self) -> usize

Return the number of coordinates in the Geometry.

fn exterior_coords_iter(&'a self) -> Self::ExteriorIter

Iterate over all exterior coordinates of a geometry.

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

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

Formats the value using the given formatter.

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

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

impl<C: GeoNum> HasDimensions for Geometry<C>

fn is_empty(&self) -> bool

Some geometries, like a MultiPoint, can have zero coordinates - we call these empty.

fn dimensions(&self) -> Dimensions

The dimensions of some geometries are fixed, e.g. a Point always has 0 dimensions. However for others, the dimensionality depends on the specific geometry instance - for example typical Rects are 2-dimensional, but it’s possible to create degenerate Rects which have either 1 or 0 dimensions.

fn boundary_dimensions(&self) -> Dimensions

The dimensions of the Geometry’s boundary, as used by OGC-SFA.

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

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl<T, G> Intersects<G> for Geometry<T> where
    T: CoordNum,
    Point<T>: Intersects<G>,
    MultiPoint<T>: Intersects<G>,
    Line<T>: Intersects<G>,
    LineString<T>: Intersects<G>,
    MultiLineString<T>: Intersects<G>,
    Triangle<T>: Intersects<G>,
    Rect<T>: Intersects<G>,
    Polygon<T>: Intersects<G>,
    MultiPolygon<T>: Intersects<G>, 

fn intersects(&self, rhs: &G) -> bool

impl<T> Intersects<Geometry<T>> for Coordinate<T> where
    Geometry<T>: Intersects<Coordinate<T>>,
    T: CoordNum, 

fn intersects(&self, rhs: &Geometry<T>) -> bool

impl<T> Intersects<Geometry<T>> for Line<T> where
    Geometry<T>: Intersects<Line<T>>,
    T: CoordNum, 

fn intersects(&self, rhs: &Geometry<T>) -> bool

impl<T> Intersects<Geometry<T>> for Rect<T> where
    Geometry<T>: Intersects<Rect<T>>,
    T: CoordNum, 

fn intersects(&self, rhs: &Geometry<T>) -> bool

impl<T> Intersects<Geometry<T>> for Polygon<T> where
    Geometry<T>: Intersects<Polygon<T>>,
    T: CoordNum, 

fn intersects(&self, rhs: &Geometry<T>) -> bool

impl<T: CoordNum, NT: CoordNum> MapCoords<T, NT> for Geometry<T>

type Output = Geometry<NT>

fn map_coords(&self, func: impl Fn(&(T, T)) -> (NT, NT) + Copy) -> Self::Output

Apply a function to all the coordinates in a geometric object, returning a new object.

impl<T: CoordNum> MapCoordsInplace<T> for Geometry<T>

fn map_coords_inplace(&mut self, func: impl Fn(&(T, T)) -> (T, T) + Copy)

Apply a function to all the coordinates in a geometric object, in place

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

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

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

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

This method tests for !=.

impl<F: GeoFloat> Relate<F, Geometry<F>> for Geometry<F>

fn relate(&self, other: &Geometry<F>) -> IntersectionMatrix

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

pub fn default_max_relative(
) -> <Geometry<T> as AbsDiffEq<Geometry<T>>>::Epsilon

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

pub fn relative_eq(
    &self,
    other: &Geometry<T>,
    epsilon: <Geometry<T> as AbsDiffEq<Geometry<T>>>::Epsilon,
    max_relative: <Geometry<T> as AbsDiffEq<Geometry<T>>>::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);

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

The inverse of [RelativeEq::relative_eq].

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

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

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

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.

pub fn try_from(
    geom: Geometry<T>
) -> Result<MultiPolygon<T>, <MultiPolygon<T> as TryFrom<Geometry<T>>>::Error>

Performs the conversion.

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

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.

pub fn try_from(
    geom: Geometry<T>
) -> Result<LineString<T>, <LineString<T> as TryFrom<Geometry<T>>>::Error>

Performs the conversion.

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

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.

pub fn try_from(
    geom: Geometry<T>
) -> Result<Polygon<T>, <Polygon<T> as TryFrom<Geometry<T>>>::Error>

Performs the conversion.

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

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.

pub fn try_from(
    geom: Geometry<T>
) -> Result<Line<T>, <Line<T> as TryFrom<Geometry<T>>>::Error>

Performs the conversion.

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

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.

pub fn try_from(
    geom: Geometry<T>
) -> Result<MultiLineString<T>, <MultiLineString<T> as TryFrom<Geometry<T>>>::Error>

Performs the conversion.

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

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.

pub fn try_from(
    geom: Geometry<T>
) -> Result<MultiPoint<T>, <MultiPoint<T> as TryFrom<Geometry<T>>>::Error>

Performs the conversion.

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

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.

pub fn try_from(
    geom: Geometry<T>
) -> Result<Triangle<T>, <Triangle<T> as TryFrom<Geometry<T>>>::Error>

Performs the conversion.

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

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.

pub fn try_from(
    geom: Geometry<T>
) -> Result<Rect<T>, <Rect<T> as TryFrom<Geometry<T>>>::Error>

Performs the conversion.

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

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.

pub fn try_from(
    geom: Geometry<T>
) -> Result<Point<T>, <Point<T> as TryFrom<Geometry<T>>>::Error>

Performs the conversion.

impl<T: CoordNum, NT: CoordNum> TryMapCoords<T, NT> for Geometry<T>

type Output = Geometry<NT>

fn try_map_coords(
    &self,
    func: impl Fn(&(T, T)) -> Result<(NT, NT), Box<dyn Error + Send + Sync>> + Copy
) -> Result<Self::Output, Box<dyn Error + Send + Sync>>

Map a fallible function over all the coordinates in a geometry, returning a Result