Struct geo_types::geometry::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::default() 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 len(&self) -> usize

Number of geometries in this GeometryCollection

pub fn is_empty(&self) -> bool

Is this GeometryCollection 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> AbsDiffEq<GeometryCollection<T>> for GeometryCollection<T>where
    T: AbsDiffEq<Epsilon = T> + CoordNum,
    T::Epsilon: Copy,

fn abs_diff_eq(&self, other: &Self, epsilon: Self::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() -> 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 + CoordNum> Clone for GeometryCollection<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug + 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<'de, T> Deserialize<'de> for GeometryCollection<T>where
    T: Deserialize<'de> + CoordNum,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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, Global>> 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> Index<usize> for GeometryCollection<T>

type Output = Geometry<T>

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

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

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

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

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

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: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> RelativeEq<GeometryCollection<T>> for GeometryCollection<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::{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() -> 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> Serialize for GeometryCollection<T>where
    T: Serialize + CoordNum,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.

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

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

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