Struct GeometryCollection 

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

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: CoordNum> GeometryCollection<T>

pub fn new() -> Self

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

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

Returns an empty GeometryCollection

pub fn len(&self) -> usize

Number of geometries in this GeometryCollection

pub fn is_empty(&self) -> bool

Returns true if this GeometryCollection contains zero geometries.

This is a purely structural check: it tests only whether the underlying collection has no elements. It does not recurse into the contained geometries, so a collection holding only empty geometries (for example a single empty LineString) is not considered empty by this method.

If you need the dimensional notion of emptiness — where a collection is empty when it has no geometries or all of its geometries are themselves empty — use geo::HasDimensions::is_empty instead.

Examples

use geo_types::{GeometryCollection, LineString};

// A collection with no geometries is empty.
let gc = GeometryCollection::<f64>::new_from(vec![]);
assert!(gc.is_empty());

// A collection containing a single (empty) geometry is NOT empty:
// the element is present even though it has no coordinates.
let gc = GeometryCollection::<f64>::new_from(vec![
    LineString::<f64>::new(vec![]).into(),
]);
assert!(!gc.is_empty());

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

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

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

Trait Implementations

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

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: CoordNum> Debug for GeometryCollection<T>

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

Formats the value using the given formatter.

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

fn default() -> Self

Returns the “default value” for a type.

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

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

DO NOT USE! Deprecated since 0.7.5.

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

fn from(x: IG) -> Self

Converts to this type from the input type.

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

fn from(geoms: Vec<IG>) -> Self

Converts to this type from the input type.

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

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

fn from_iter<I: IntoIterator<Item = IG>>(iter: I) -> Self

Creates a value from an iterator.

impl<T: Hash + CoordNum> Hash for GeometryCollection<T>

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

Feeds a slice of this type into the given Hasher.

impl<T: CoordNum, I: SliceIndex<[Geometry<T>]>> Index<I> for GeometryCollection<T>

type Output = <I as SliceIndex<[Geometry<T>]>>::Output

The returned type after indexing.

fn index(&self, index: I) -> &I::Output

Performs the indexing (container[index]) operation.

impl<T: CoordNum, I: SliceIndex<[Geometry<T>]>> IndexMut<I> for GeometryCollection<T>

fn index_mut(&mut self, index: I) -> &mut I::Output

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

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

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) -> Self::IntoIter

Creates an iterator from a value.

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

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) -> Self::IntoIter

Creates an iterator from a value.

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

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) -> Self::IntoIter

Creates an iterator from a value.

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

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

Equality operator ==.

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

Inequality operator !=.

impl<T: PartialEq + CoordNum> StructuralPartialEq for GeometryCollection<T>