Struct MultiLineString 

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

Available on crate feature geo-types only.

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

where T: CoordNum,

pub fn new(value: Vec<LineString<T>>) -> MultiLineString<T>

Returns a MultiLineString with the given LineStrings as elements

pub fn empty() -> MultiLineString<T>

Returns an empty MultiLineString

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::new(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::new(vec![closed_line_string.clone()]).is_closed());

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

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

impl<T> MultiLineString<T>

where T: CoordNum,

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

where T: Clone + CoordNum,

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for MultiLineString<T>

where T: CoordNum,

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

Formats the value using the given formatter.

impl<T, ILS> From<ILS> for MultiLineString<T>

where T: CoordNum, ILS: Into<LineString<T>>,

fn from(ls: ILS) -> MultiLineString<T>

Converts to this type from the input type.

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

where T: CoordNum,

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

Converts to this type from the input type.

impl<T> From<MultiLineString<T>> for MultiLineString<T>

where T: CoordNum,

fn from(multi_line_string: MultiLineString<T>) -> MultiLineString<T>

Convert from a WKT MULTILINESTRING to a geo_types::MultiLineString

impl<T, ILS> FromIterator<ILS> for MultiLineString<T>

where T: CoordNum, ILS: Into<LineString<T>>,

fn from_iter<I>(iter: I) -> MultiLineString<T>

where I: IntoIterator<Item = ILS>,

Creates a value from an iterator.

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

where T: CoordNum + 'a,

type T = T

The coordinate type of this geometry

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

The type of each underlying Point, which implements PointTrait

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

The type of each underlying LineString, which implements LineStringTrait

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

The type of each underlying Polygon, which implements PolygonTrait

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

The type of each underlying MultiPoint, which implements MultiPointTrait

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

The type of each underlying MultiLineString, which implements MultiLineStringTrait

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

The type of each underlying MultiPolygon, which implements MultiPolygonTrait

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

The type of each underlying GeometryCollection, which implements GeometryCollectionTrait

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

The type of each underlying Rect, which implements RectTrait

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

The type of each underlying Triangle, which implements TriangleTrait

type LineType<'b> = Line<<&'a MultiLineString<T> as GeometryTrait>::T> where &'a MultiLineString<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 MultiLineString<T>

where T: CoordNum,

type T = T

The coordinate type of this geometry

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

The type of each underlying Point, which implements PointTrait

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

The type of each underlying LineString, which implements LineStringTrait

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

The type of each underlying Polygon, which implements PolygonTrait

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

The type of each underlying MultiPoint, which implements MultiPointTrait

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

The type of each underlying MultiLineString, which implements MultiLineStringTrait

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

The type of each underlying MultiPolygon, which implements MultiPolygonTrait

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

The type of each underlying GeometryCollection, which implements GeometryCollectionTrait

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

The type of each underlying Rect, which implements RectTrait

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

The type of each underlying Triangle, which implements TriangleTrait

type LineType<'b> = Line<<MultiLineString<T> as GeometryTrait>::T> where MultiLineString<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 MultiLineString<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<'a, T> IntoIterator for &'a MultiLineString<T>

where T: CoordNum,

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) -> <&'a MultiLineString<T> as IntoIterator>::IntoIter

Creates an iterator from a value.

impl<'a, T> IntoIterator for &'a mut MultiLineString<T>

where T: CoordNum,

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) -> <&'a mut MultiLineString<T> as IntoIterator>::IntoIter

Creates an iterator from a value.

impl<T> IntoIterator for MultiLineString<T>

where T: CoordNum,

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) -> <MultiLineString<T> as IntoIterator>::IntoIter

Creates an iterator from a value.

impl<'a, T> MultiLineStringTrait for &'a MultiLineString<T>

where T: CoordNum,

type InnerLineStringType<'b> = &'a LineString<<&'a MultiLineString<T> as GeometryTrait>::T> where &'a MultiLineString<T>: 'b

The type of each underlying LineString, which implements LineStringTrait

fn num_line_strings(&self) -> usize

The number of line_strings in this MultiLineString

unsafe fn line_string_unchecked( &self, i: usize, ) -> <&'a MultiLineString<T> as MultiLineStringTrait>::InnerLineStringType<'_>

Access to a specified line_string in this MultiLineString

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

An iterator over the LineStrings in this MultiLineString

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

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

impl<T> MultiLineStringTrait for MultiLineString<T>

where T: CoordNum,

type InnerLineStringType<'a> = &'a LineString<<MultiLineString<T> as GeometryTrait>::T> where MultiLineString<T>: 'a

The type of each underlying LineString, which implements LineStringTrait

fn num_line_strings(&self) -> usize

The number of line_strings in this MultiLineString

unsafe fn line_string_unchecked( &self, i: usize, ) -> <MultiLineString<T> as MultiLineStringTrait>::InnerLineStringType<'_>

Access to a specified line_string in this MultiLineString

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

An iterator over the LineStrings in this MultiLineString

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

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

impl<T> PartialEq for MultiLineString<T>

where T: PartialEq + CoordNum,

fn eq(&self, other: &MultiLineString<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 MultiLineString<T>

where T: CoordNum + Display,

Examples

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

let line_string_1: LineString<f64> = line_string![(x: 1., y: 2.), (x: 3., y: 4.), (x: 5., y: 6.)];
let line_string_2: LineString<f64> = line_string![(x: 7., y: 8.), (x: 9., y: 0.)];
let multi_line_string: MultiLineString<f64> = MultiLineString::new(vec![line_string_1, line_string_2]);

assert_eq!(multi_line_string.wkt_string(), "MULTILINESTRING((1 2,3 4,5 6),(7 8,9 0))");

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

where T: CoordNum,

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<MultiLineString<T>, <MultiLineString<T> as TryFrom<Geometry<T>>>::Error>

Performs the conversion.

impl<T> TryFrom<Wkt<T>> for MultiLineString<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<MultiLineString<T>, <MultiLineString<T> as TryFrom<Wkt<T>>>::Error>

Performs the conversion.

impl<T> TryFromWkt<T> for MultiLineString<T>

where T: CoordNum + FromStr + Default,

type Error = Error

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

Examples

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

Examples

impl<T> Eq for MultiLineString<T>

where T: Eq + CoordNum,

impl<T> StructuralPartialEq for MultiLineString<T>

where T: CoordNum,