Struct geo::GeometryCollection

pub struct GeometryCollection<T>(pub Vec<Geometry<T>, Global>) 
where
    T: CoordNum;

A collection of Geometry types.

It can be created from a Vec of Geometries, or from an Iterator which yields Geometries.

Looping over this object yields its component Geometry enum members (not the underlying geometry primitives), and it supports iteration and indexing as well as the various MapCoords functions, which are directly applied to the underlying geometry primitives.

Examples

Looping

use std::convert::TryFrom;
use geo_types::{Point, point, Geometry, GeometryCollection};
let p = point!(x: 1.0, y: 1.0);
let pe = Geometry::Point(p);
let gc = GeometryCollection::new_from(vec![pe]);
for geom in gc {
    println!("{:?}", Point::try_from(geom).unwrap().x());
}

Implements iter()

use std::convert::TryFrom;
use geo_types::{Point, point, Geometry, GeometryCollection};
let p = point!(x: 1.0, y: 1.0);
let pe = Geometry::Point(p);
let gc = GeometryCollection::new_from(vec![pe]);
gc.iter().for_each(|geom| println!("{:?}", geom));

Mutable Iteration

use std::convert::TryFrom;
use geo_types::{Point, point, Geometry, GeometryCollection};
let p = point!(x: 1.0, y: 1.0);
let pe = Geometry::Point(p);
let mut gc = GeometryCollection::new_from(vec![pe]);
gc.iter_mut().for_each(|geom| {
   if let Geometry::Point(p) = geom {
       p.set_x(0.2);
   }
});
let updated = gc[0].clone();
assert_eq!(Point::try_from(updated).unwrap().x(), 0.2);

Indexing

use std::convert::TryFrom;
use geo_types::{Point, point, Geometry, GeometryCollection};
let p = point!(x: 1.0, y: 1.0);
let pe = Geometry::Point(p);
let gc = GeometryCollection::new_from(vec![pe]);
println!("{:?}", gc[0]);

Tuple Fields

0: Vec<Geometry<T>, Global>

Implementations

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

pub fn new() -> GeometryCollection<T>

👎 Deprecated:

Will be replaced with a parametrized version in upcoming version. Use GeometryCollection::default() instead

Return an empty GeometryCollection

pub fn new_from(value: Vec<Geometry<T>, Global>) -> GeometryCollection<T>

DO NOT USE! This fn will be renamed to new in the upcoming version. This fn is not marked as deprecated because it would require extensive refactoring of the geo code.

pub fn len(&self) -> usize

Number of geometries in this GeometryCollection

pub fn is_empty(&self) -> bool

Is this GeometryCollection empty

impl<'a, T> GeometryCollection<T> where
    T: CoordNum, 

pub fn iter(&'a self) -> IterHelper<'a, T>

pub fn iter_mut(&'a mut self) -> IterMutHelper<'a, T>

Trait Implementations

impl<T> AbsDiffEq<GeometryCollection<T>> for GeometryCollection<T> where
    T: AbsDiffEq<T, Epsilon = T> + CoordNum,
    <T as AbsDiffEq<T>>::Epsilon: Copy, 

fn abs_diff_eq(
    &self,
    other: &GeometryCollection<T>,
    epsilon: <GeometryCollection<T> as AbsDiffEq<GeometryCollection<T>>>::Epsilon
) -> bool

Equality assertion with an absolute limit.

Examples

use geo_types::{GeometryCollection, point};

let a = GeometryCollection::new_from(vec![point![x: 0.0, y: 0.0].into()]);
let b = GeometryCollection::new_from(vec![point![x: 0.0, y: 0.1].into()]);

approx::abs_diff_eq!(a, b, epsilon=0.1);
approx::abs_diff_ne!(a, b, epsilon=0.001);

type Epsilon = T

Used for specifying relative comparisons.

fn default_epsilon(
) -> <GeometryCollection<T> as AbsDiffEq<GeometryCollection<T>>>::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> Area<T> for GeometryCollection<T> where
    T: CoordFloat, 

fn signed_area(&self) -> T

fn unsigned_area(&self) -> T

impl<T> BoundingRect<T> for GeometryCollection<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 GeometryCollection<T> where
    T: GeoFloat, 

type Output = Option<Point<T>>

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

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

impl<T> ChamberlainDuquetteArea<T> for GeometryCollection<T> where
    T: Float + CoordNum, 

fn chamberlain_duquette_signed_area(&self) -> T

fn chamberlain_duquette_unsigned_area(&self) -> T

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F: GeoFloat> ClosestPoint<F, Point<F>> for GeometryCollection<F>

fn closest_point(&self, p: &Point<F>) -> Closest<F>

Find the closest point between self and p.

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

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

impl<F> Contains<GeometryCollection<F>> for MultiPolygon<F> where
    F: GeoFloat, 

fn contains(&self, rhs: &GeometryCollection<F>) -> bool

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

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

impl<T> CoordinatePosition for GeometryCollection<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 GeometryCollection<T>

fn coords_count(&'a self) -> usize

Return the number of coordinates in the GeometryCollection.

type Iter = Box<dyn Iterator<Item = Coordinate<T>> + 'a, Global>

type ExteriorIter = Box<dyn Iterator<Item = Coordinate<T>> + 'a, Global>

type Scalar = T

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

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

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

Iterate over all exterior coordinates of a geometry.

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

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

Formats the value using the given formatter.

impl<T> Default for GeometryCollection<T> where
    T: CoordNum, 

fn default() -> GeometryCollection<T>

Returns the “default value” for a type.

impl<T, IG> From<IG> for GeometryCollection<T> where
    T: CoordNum,
    IG: Into<Geometry<T>>, 

fn from(x: IG) -> GeometryCollection<T>

Converts to this type from the input type.

impl<T, IG> From<Vec<IG, Global>> for GeometryCollection<T> where
    T: CoordNum,
    IG: Into<Geometry<T>>, 

fn from(geoms: Vec<IG, Global>) -> GeometryCollection<T>

Converts to this type from the input type.

impl<T, IG> FromIterator<IG> for GeometryCollection<T> where
    T: CoordNum,
    IG: Into<Geometry<T>>, 

Collect Geometries (or what can be converted to a Geometry) into a GeometryCollection

fn from_iter<I>(iter: I) -> GeometryCollection<T> where
    I: IntoIterator<Item = IG>, 

Creates a value from an iterator.

impl<C: GeoNum> HasDimensions for GeometryCollection<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 GeometryCollection<T> where
    T: Hash + CoordNum, 

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

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> Index<usize> for GeometryCollection<T> where
    T: CoordNum, 

type Output = Geometry<T>

The returned type after indexing.

fn index(&self, index: usize) -> &Geometry<T>

Performs the indexing (container[index]) operation.

impl<T> IndexMut<usize> for GeometryCollection<T> where
    T: CoordNum, 

fn index_mut(&mut self, index: usize) -> &mut Geometry<T>

Performs the mutable indexing (container[index]) operation.

impl<T, G> Intersects<G> for GeometryCollection<T> where
    T: CoordNum,
    Geometry<T>: Intersects<G>,
    G: BoundingRect<T>, 

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

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

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

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

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

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

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

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

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

impl<'a, T> IntoIterator for &'a mut GeometryCollection<T> where
    T: CoordNum, 

type Item = &'a mut Geometry<T>

The type of the elements being iterated over.

type IntoIter = IterMutHelper<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <&'a mut GeometryCollection<T> as IntoIterator>::IntoIter

Creates an iterator from a value.

impl<'a, T> IntoIterator for &'a GeometryCollection<T> where
    T: CoordNum, 

type Item = &'a Geometry<T>

The type of the elements being iterated over.

type IntoIter = IterHelper<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <&'a GeometryCollection<T> as IntoIterator>::IntoIter

Creates an iterator from a value.

impl<T> IntoIterator for GeometryCollection<T> where
    T: CoordNum, 

type Item = Geometry<T>

The type of the elements being iterated over.

type IntoIter = IntoIteratorHelper<T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <GeometryCollection<T> as IntoIterator>::IntoIter

Creates an iterator from a value.

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

type Output = GeometryCollection<NT>

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

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

fn try_map_coords<E>(
    &self,
    func: impl Fn(Coordinate<T>) -> Result<Coordinate<NT>, E> + Copy
) -> Result<Self::Output, E>

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

impl<T: CoordNum> MapCoordsInPlace<T> for GeometryCollection<T>

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

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

fn try_map_coords_in_place<E>(
    &mut self,
    func: impl Fn(Coordinate<T>) -> Result<Coordinate<T>, E>
) -> Result<(), E>

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

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

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

👎 Deprecated since 0.21.0:

use MapCoordsInPlace::map_coords_in_place instead which takes a Coordinate instead of an (x,y) tuple

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

Examples

#[allow(deprecated)]
use geo::MapCoordsInplace;
use geo::Point;
use approx::assert_relative_eq;

let mut p = Point::new(10., 20.);
#[allow(deprecated)]
p.map_coords_inplace(|(x, y)| (x + 1000., y * 2.));

assert_relative_eq!(p, Point::new(1010., 40.), epsilon = 1e-6);

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

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

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

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

This method tests for !=.

impl<F: GeoFloat> Relate<F, GeometryCollection<F>> for Point<F>

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

impl<F: GeoFloat> Relate<F, GeometryCollection<F>> for Line<F>

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

impl<F: GeoFloat> Relate<F, GeometryCollection<F>> for LineString<F>

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

impl<F: GeoFloat> Relate<F, GeometryCollection<F>> for Polygon<F>

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

impl<F: GeoFloat> Relate<F, GeometryCollection<F>> for MultiPoint<F>

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

impl<F: GeoFloat> Relate<F, GeometryCollection<F>> for MultiLineString<F>

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

impl<F: GeoFloat> Relate<F, GeometryCollection<F>> for MultiPolygon<F>

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

impl<F: GeoFloat> Relate<F, GeometryCollection<F>> for Rect<F>

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

impl<F: GeoFloat> Relate<F, GeometryCollection<F>> for Triangle<F>

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

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

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

impl<F: GeoFloat> Relate<F, Line<F>> for GeometryCollection<F>

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

impl<F: GeoFloat> Relate<F, LineString<F>> for GeometryCollection<F>

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

impl<F: GeoFloat> Relate<F, MultiLineString<F>> for GeometryCollection<F>

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

impl<F: GeoFloat> Relate<F, MultiPoint<F>> for GeometryCollection<F>

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

impl<F: GeoFloat> Relate<F, MultiPolygon<F>> for GeometryCollection<F>

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

impl<F: GeoFloat> Relate<F, Point<F>> for GeometryCollection<F>

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

impl<F: GeoFloat> Relate<F, Polygon<F>> for GeometryCollection<F>

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

impl<F: GeoFloat> Relate<F, Rect<F>> for GeometryCollection<F>

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

impl<F: GeoFloat> Relate<F, Triangle<F>> for GeometryCollection<F>

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

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

fn relative_eq(
    &self,
    other: &GeometryCollection<T>,
    epsilon: <GeometryCollection<T> as AbsDiffEq<GeometryCollection<T>>>::Epsilon,
    max_relative: <GeometryCollection<T> as AbsDiffEq<GeometryCollection<T>>>::Epsilon
) -> bool

Equality assertion within a relative limit.

Examples

use geo_types::{GeometryCollection, point};

let a = GeometryCollection::new_from(vec![point![x: 1.0, y: 2.0].into()]);
let b = GeometryCollection::new_from(vec![point![x: 1.0, y: 2.01].into()]);

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

fn default_max_relative(
) -> <GeometryCollection<T> as AbsDiffEq<GeometryCollection<T>>>::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, NT: CoordNum, E> TryMapCoords<T, NT, E> for GeometryCollection<T>

type Output = GeometryCollection<NT>

👎 Deprecated since 0.21.0:

use MapCoords::try_map_coords which takes a Coordinate instead of an (x,y) tuple

fn try_map_coords(
    &self,
    func: impl Fn((T, T)) -> Result<(NT, NT), E> + Copy
) -> Result<Self::Output, E>

👎 Deprecated since 0.21.0:

use MapCoords::try_map_coords which takes a Coordinate instead of an (x,y) tuple

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

impl<T: CoordNum, E> TryMapCoordsInplace<T, E> for GeometryCollection<T>

fn try_map_coords_inplace(
    &mut self,
    func: impl Fn((T, T)) -> Result<(T, T), E>
) -> Result<(), E>

👎 Deprecated since 0.21.0:

use MapCoordsInPlace::try_map_coords_in_place which takes a Coordinate instead of an (x,y) tuple

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

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

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

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