Struct geo_types::MultiLineString

pub struct MultiLineString<T>(pub Vec<LineString<T>>)
 where
    T: CoordNum;

A collection of LineStrings. Can be created from a Vec of LineStrings or from an Iterator which yields LineStrings. Iterating over this object yields the component LineStrings.

Semantics

The boundary of a MultiLineString is obtained by applying the “mod 2” union rule: A Point is in the boundary of a MultiLineString if it is in the boundaries of an odd number of elements of the MultiLineString.

The interior of a MultiLineString is the union of the interior, and boundary of the constituent LineStrings, except for the boundary as defined above. In other words, it is the set difference of the boundary from the union of the interior and boundary of the constituents.

A MultiLineString is simple if and only if all of its elements are simple and the only intersections between any two elements occur at Points that are on the boundaries of both elements. A MultiLineString is closed if all of its elements are closed. The boundary of a closed MultiLineString is always empty.

Tuple Fields

0: Vec<LineString<T>>

Implementations

impl<T: CoordNum> MultiLineString<T>

pub fn is_closed(&self) -> bool

True if the MultiLineString is empty or if all of its LineStrings are closed - see LineString::is_closed.

Examples

use geo_types::{MultiLineString, LineString, line_string};

let open_line_string: LineString<f32> = line_string![(x: 0., y: 0.), (x: 5., y: 0.)];
assert!(!MultiLineString(vec![open_line_string.clone()]).is_closed());

let closed_line_string: LineString<f32> = line_string![(x: 0., y: 0.), (x: 5., y: 0.), (x: 0., y: 0.)];
assert!(MultiLineString(vec![closed_line_string.clone()]).is_closed());

// MultiLineString is not closed if *any* of it's LineStrings are not closed
assert!(!MultiLineString(vec![open_line_string, closed_line_string]).is_closed());

// An empty MultiLineString is closed
assert!(MultiLineString::<f32>(vec![]).is_closed());

impl<T: CoordNum> MultiLineString<T>

pub fn iter(&self) -> impl Iterator<Item = &LineString<T>>

pub fn iter_mut(&mut self) -> impl Iterator<Item = &mut LineString<T>>

Trait Implementations

impl<T> AbsDiffEq<MultiLineString<T>> for MultiLineString<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::{MultiLineString, line_string};

let a = MultiLineString(vec![line_string![(x: 0., y: 0.), (x: 10., y: 10.)]]);
let b = MultiLineString(vec![line_string![(x: 0., y: 0.), (x: 10.01, y: 10.)]]);

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> Clone for MultiLineString<T> where
    T: CoordNum, 

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for MultiLineString<T> where
    T: CoordNum, 

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

Formats the value using the given formatter.

impl<T: CoordNum, ILS: Into<LineString<T>>> From<ILS> for MultiLineString<T>

fn from(ls: ILS) -> Self

Performs the conversion.

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

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

Performs the conversion.

impl<T: CoordNum, ILS: Into<LineString<T>>> FromIterator<ILS> for MultiLineString<T>

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

Creates a value from an iterator.

impl<T: Hash> Hash for MultiLineString<T> where
    T: CoordNum, 

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, 

Feeds a slice of this type into the given Hasher.

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

type Item = LineString<T>

The type of the elements being iterated over.

type IntoIter = IntoIter<LineString<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 MultiLineString<T>

type Item = &'a LineString<T>

The type of the elements being iterated over.

type IntoIter = Iter<'a, LineString<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 MultiLineString<T>

type Item = &'a mut LineString<T>

The type of the elements being iterated over.

type IntoIter = IterMut<'a, LineString<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> PartialEq<MultiLineString<T>> for MultiLineString<T> where
    T: CoordNum, 

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

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

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

This method tests for !=.

impl<T> RelativeEq<MultiLineString<T>> for MultiLineString<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::{MultiLineString, line_string};

let a = MultiLineString(vec![line_string![(x: 0., y: 0.), (x: 10., y: 10.)]]);
let b = MultiLineString(vec![line_string![(x: 0., y: 0.), (x: 10.01, y: 10.)]]);

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: CoordNum> TryFrom<Geometry<T>> for MultiLineString<T>

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.

fn try_from(geom: Geometry<T>) -> Result<Self, Self::Error>

Performs the conversion.

impl<T: Eq> Eq for MultiLineString<T> where
    T: CoordNum, 

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

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