Struct GeometryCollection 

pub struct GeometryCollection<T = f64>(pub Vec<Geometry<T>>)
where
    T: CoordNum;

Available on crate feature geo-types only.

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

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::empty() instead

Return an empty GeometryCollection

pub fn new_from(value: Vec<Geometry<T>>) -> 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 empty() -> GeometryCollection<T>

Returns an empty GeometryCollection

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> Clone for GeometryCollection<T>

where T: Clone + CoordNum,

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for GeometryCollection<T>

where T: 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>>,

DO NOT USE! Deprecated since 0.7.5.

Use GeometryCollection::from(vec![geom]) instead.

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

Converts to this type from the input type.

impl<T, IG> From<Vec<IG>> for GeometryCollection<T>

where T: CoordNum, IG: Into<Geometry<T>>,

fn from(geoms: Vec<IG>) -> 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<'a, T> GeometryCollectionTrait for &'a GeometryCollection<T>

where T: CoordNum,

type GeometryType<'b> = &'a Geometry<<&'a GeometryCollection<T> as GeometryTrait>::T> where &'a GeometryCollection<T>: 'b

The type of each underlying geometry, which implements GeometryTrait

fn num_geometries(&self) -> usize

The number of geometries in this GeometryCollection

unsafe fn geometry_unchecked( &self, i: usize, ) -> <&'a GeometryCollection<T> as GeometryCollectionTrait>::GeometryType<'_>

Access to a specified geometry in this GeometryCollection

fn geometries(&self) -> impl DoubleEndedIterator + ExactSizeIterator

An iterator over the geometries in this GeometryCollection

fn geometry(&self, i: usize) -> Option<Self::GeometryType<'_>>

Access to a specified geometry in this GeometryCollection Will return None if the provided index is out of bounds

impl<T> GeometryCollectionTrait for GeometryCollection<T>

where T: CoordNum,

type GeometryType<'a> = &'a Geometry<<GeometryCollection<T> as GeometryTrait>::T> where GeometryCollection<T>: 'a

The type of each underlying geometry, which implements GeometryTrait

fn num_geometries(&self) -> usize

The number of geometries in this GeometryCollection

unsafe fn geometry_unchecked( &self, i: usize, ) -> <GeometryCollection<T> as GeometryCollectionTrait>::GeometryType<'_>

Access to a specified geometry in this GeometryCollection

fn geometries(&self) -> impl DoubleEndedIterator + ExactSizeIterator

An iterator over the geometries in this GeometryCollection

fn geometry(&self, i: usize) -> Option<Self::GeometryType<'_>>

Access to a specified geometry in this GeometryCollection Will return None if the provided index is out of bounds

impl<'a, T> GeometryTrait for &'a GeometryCollection<T>

where T: CoordNum + 'a,

type T = T

The coordinate type of this geometry

type PointType<'b> = Point<<&'a GeometryCollection<T> as GeometryTrait>::T> where &'a GeometryCollection<T>: 'b

The type of each underlying Point, which implements PointTrait

type LineStringType<'b> = LineString<<&'a GeometryCollection<T> as GeometryTrait>::T> where &'a GeometryCollection<T>: 'b

The type of each underlying LineString, which implements LineStringTrait

type PolygonType<'b> = Polygon<<&'a GeometryCollection<T> as GeometryTrait>::T> where &'a GeometryCollection<T>: 'b

The type of each underlying Polygon, which implements PolygonTrait

type MultiPointType<'b> = MultiPoint<<&'a GeometryCollection<T> as GeometryTrait>::T> where &'a GeometryCollection<T>: 'b

The type of each underlying MultiPoint, which implements MultiPointTrait

type MultiLineStringType<'b> = MultiLineString<<&'a GeometryCollection<T> as GeometryTrait>::T> where &'a GeometryCollection<T>: 'b

The type of each underlying MultiLineString, which implements MultiLineStringTrait

type MultiPolygonType<'b> = MultiPolygon<<&'a GeometryCollection<T> as GeometryTrait>::T> where &'a GeometryCollection<T>: 'b

The type of each underlying MultiPolygon, which implements MultiPolygonTrait

type GeometryCollectionType<'b> = GeometryCollection<<&'a GeometryCollection<T> as GeometryTrait>::T> where &'a GeometryCollection<T>: 'b

The type of each underlying GeometryCollection, which implements GeometryCollectionTrait

type RectType<'b> = Rect<<&'a GeometryCollection<T> as GeometryTrait>::T> where &'a GeometryCollection<T>: 'b

The type of each underlying Rect, which implements RectTrait

type TriangleType<'b> = Triangle<<&'a GeometryCollection<T> as GeometryTrait>::T> where &'a GeometryCollection<T>: 'b

The type of each underlying Triangle, which implements TriangleTrait

type LineType<'b> = Line<<&'a GeometryCollection<T> as GeometryTrait>::T> where &'a GeometryCollection<T>: 'b

The type of each underlying Line, which implements LineTrait

fn dim(&self) -> Dimensions

The dimension of this geometry

fn as_type( &self, ) -> GeometryType<'_, Point<T>, LineString<T>, Polygon<T>, MultiPoint<T>, MultiLineString<T>, MultiPolygon<T>, GeometryCollection<T>, Rect<T>, Triangle<T>, Line<T>>

Cast this geometry to a GeometryType enum, which allows for downcasting to a specific type

impl<T> GeometryTrait for GeometryCollection<T>

where T: CoordNum,

type T = T

The coordinate type of this geometry

type PointType<'b> = Point<<GeometryCollection<T> as GeometryTrait>::T> where GeometryCollection<T>: 'b

The type of each underlying Point, which implements PointTrait

type LineStringType<'b> = LineString<<GeometryCollection<T> as GeometryTrait>::T> where GeometryCollection<T>: 'b

The type of each underlying LineString, which implements LineStringTrait

type PolygonType<'b> = Polygon<<GeometryCollection<T> as GeometryTrait>::T> where GeometryCollection<T>: 'b

The type of each underlying Polygon, which implements PolygonTrait

type MultiPointType<'b> = MultiPoint<<GeometryCollection<T> as GeometryTrait>::T> where GeometryCollection<T>: 'b

The type of each underlying MultiPoint, which implements MultiPointTrait

type MultiLineStringType<'b> = MultiLineString<<GeometryCollection<T> as GeometryTrait>::T> where GeometryCollection<T>: 'b

The type of each underlying MultiLineString, which implements MultiLineStringTrait

type MultiPolygonType<'b> = MultiPolygon<<GeometryCollection<T> as GeometryTrait>::T> where GeometryCollection<T>: 'b

The type of each underlying MultiPolygon, which implements MultiPolygonTrait

type GeometryCollectionType<'b> = GeometryCollection<<GeometryCollection<T> as GeometryTrait>::T> where GeometryCollection<T>: 'b

The type of each underlying GeometryCollection, which implements GeometryCollectionTrait

type RectType<'b> = Rect<<GeometryCollection<T> as GeometryTrait>::T> where GeometryCollection<T>: 'b

The type of each underlying Rect, which implements RectTrait

type TriangleType<'b> = Triangle<<GeometryCollection<T> as GeometryTrait>::T> where GeometryCollection<T>: 'b

The type of each underlying Triangle, which implements TriangleTrait

type LineType<'b> = Line<<GeometryCollection<T> as GeometryTrait>::T> where GeometryCollection<T>: 'b

The type of each underlying Line, which implements LineTrait

fn dim(&self) -> Dimensions

The dimension of this geometry

fn as_type( &self, ) -> GeometryType<'_, Point<T>, LineString<T>, Polygon<T>, MultiPoint<T>, MultiLineString<T>, MultiPolygon<T>, GeometryCollection<T>, Rect<T>, Triangle<T>, Line<T>>

Cast this geometry to a GeometryType enum, which allows for downcasting to a specific type

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, Self: Sized,

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<'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<'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<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> PartialEq for GeometryCollection<T>

where T: PartialEq + CoordNum,

fn eq(&self, other: &GeometryCollection<T>) -> 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<T> ToWkt<T> for GeometryCollection<T>

where T: CoordNum + Display,

Examples

use geo_types::{line_string, LineString, polygon, Polygon, GeometryCollection};
use wkt::ToWkt;

let polygon: Polygon<f64> = polygon![(x: 0., y: 0.), (x: 4., y: 0.), (x: 2., y: 4.), (x: 0., y: 0.)];
let line_string: LineString<f64> = line_string![(x: 1., y: 2.), (x: 3., y: 4.), (x: 5., y: 6.)];
let geometry_collection: GeometryCollection<f64> = GeometryCollection::new_from(vec![polygon.into(), line_string.into()]);

assert_eq!(geometry_collection.wkt_string(), "GEOMETRYCOLLECTION(POLYGON((0 0,4 0,2 4,0 0)),LINESTRING(1 2,3 4,5 6))");

fn to_wkt(&self) -> Wkt<T>

Converts the value of self to an Wkt struct.

fn write_wkt(&self, writer: impl Write) -> Result<(), Error>

Write a WKT string to a File, or anything else that implements Write.

fn wkt_string(&self) -> String

Serialize as a WKT string

impl<T> TryFrom<GeometryCollection<T>> for GeometryCollection<T>

where T: CoordNum,

type Error = Error

The type returned in the event of a conversion error.

fn try_from( geometry_collection: GeometryCollection<T>, ) -> Result<GeometryCollection<T>, <GeometryCollection<T> as TryFrom<GeometryCollection<T>>>::Error>

Performs the conversion.

impl<T> TryFrom<Wkt<T>> for GeometryCollection<T>

where T: CoordNum,

Fallibly convert this WKT primitive into this geo_types primitive

type Error = Error

The type returned in the event of a conversion error.

fn try_from( wkt: Wkt<T>, ) -> Result<GeometryCollection<T>, <GeometryCollection<T> as TryFrom<Wkt<T>>>::Error>

Performs the conversion.

impl<T> TryFromWkt<T> for GeometryCollection<T>

where T: CoordNum + FromStr + Default,

type Error = Error

fn try_from_wkt_str( wkt_str: &str, ) -> Result<GeometryCollection<T>, <GeometryCollection<T> as TryFromWkt<T>>::Error>

Examples

fn try_from_wkt_reader( wkt_reader: impl Read, ) -> Result<GeometryCollection<T>, <GeometryCollection<T> as TryFromWkt<T>>::Error>

Examples

impl<T> Eq for GeometryCollection<T>

where T: Eq + CoordNum,

impl<T> StructuralPartialEq for GeometryCollection<T>

where T: CoordNum,