Struct geo::LineString

pub struct LineString<T>(pub Vec<Point<T>>)
 where
    T: CoordinateType;

An ordered collection of two or more Points, representing a path between locations

Create a LineString by calling it directly:

use geo_types::{LineString, Point};
let line = LineString(vec![Point::new(0., 0.), Point::new(10., 0.)]);

Converting a Vec of Point-like things:

let line: LineString<f32> = vec![(0., 0.), (10., 0.)].into();

Or collecting from a Point iterator

let mut points = vec![Point::new(0., 0.), Point::new(10., 0.)];
let line: LineString<f32> = points.into_iter().collect();

You can iterate over the points in the LineString

use geo_types::{LineString, Point};
let line = LineString(vec![Point::new(0., 0.), Point::new(10., 0.)]);
for point in line {
    println!("Point x = {}, y = {}", point.x(), point.y());
}

Methods

impl<T> LineString<T> where
    T: CoordinateType, 

Important traits for Box<W>

impl<W> Write for Box<W> where
    W: Write + ?Sized, impl<R> Read for Box<R> where
    R: Read + ?Sized, impl<I> Iterator for Box<I> where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

pub fn lines(&'a self) -> Box<Iterator<Item = Line<T>> + 'a>

Return an Line iterator that yields one Line for each line segment in the LineString.

Examples

use geo_types::{Line, LineString, Point};

let mut points = vec![(0., 0.), (5., 0.), (7., 9.)];
let linestring: LineString<f32> = points.into_iter().collect();

let mut lines = linestring.lines();
assert_eq!(
    Some(Line::new(Point::new(0., 0.), Point::new(5., 0.))),
    lines.next()
);
assert_eq!(
    Some(Line::new(Point::new(5., 0.), Point::new(7., 9.))),
    lines.next()
);
assert!(lines.next().is_none());

Important traits for Iter<'a, T>

impl<'a, T> Iterator for Iter<'a, T> type Item = &'a T;

pub fn points(&self) -> Iter<Point<T>>

Important traits for IterMut<'a, T>

impl<'a, T> Iterator for IterMut<'a, T> type Item = &'a mut T;

pub fn points_mut(&mut self) -> IterMut<Point<T>>

Trait Implementations

impl<'de, T> Deserialize<'de> for LineString<T> where
    T: CoordinateType + Deserialize<'de>, 

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

Deserialize this value from the given Serde deserializer.

impl<T> IntoIterator for LineString<T> where
    T: CoordinateType, 

Iterate over all the Points in this linestring

type Item = Point<T>

The type of the elements being iterated over.

type IntoIter = IntoIter<Point<T>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <LineString<T> as IntoIterator>::IntoIter

Creates an iterator from a value.

impl<T> Serialize for LineString<T> where
    T: CoordinateType + Serialize, 

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

Serialize this value into the given Serde serializer.

impl<T, IP> FromIterator<IP> for LineString<T> where
    IP: Into<Point<T>>,
    T: CoordinateType, 

Turn a Point-ish iterator into a LineString.

fn from_iter<I>(iter: I) -> LineString<T> where
    I: IntoIterator<Item = IP>, 

Creates a value from an iterator.

impl<T> PartialEq<LineString<T>> for LineString<T> where
    T: PartialEq<T> + CoordinateType, 

fn eq(&self, __arg_0: &LineString<T>) -> bool

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

fn ne(&self, __arg_0: &LineString<T>) -> bool

This method tests for !=.

impl<T, IP> From<Vec<IP>> for LineString<T> where
    IP: Into<Point<T>>,
    T: CoordinateType, 

Turn a Vec of Point-ish objects into a LineString.

fn from(v: Vec<IP>) -> LineString<T>

Performs the conversion.

impl<T> From<LineString<T>> for Geometry<T> where
    T: CoordinateType, 

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

Performs the conversion.

impl<T> Clone for LineString<T> where
    T: Clone + CoordinateType, 

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for LineString<T> where
    T: Debug + CoordinateType, 

fn fmt(&self, __arg_0: &mut Formatter) -> Result<(), Error>

Formats the value using the given formatter.

impl<T> Centroid<T> for LineString<T> where
    T: Float, 

type Output = Option<Point<T>>

fn centroid(&self) -> Self::Output

See: https://en.wikipedia.org/wiki/Centroid

impl<T> Contains<Point<T>> for LineString<T> where
    T: Float, 

fn contains(&self, p: &Point<T>) -> bool

Checks if the geometry A is completely inside the B geometry.

impl<T> Contains<LineString<T>> for Line<T> where
    T: Float, 

fn contains(&self, linestring: &LineString<T>) -> bool

Checks if the geometry A is completely inside the B geometry.

impl<T> Contains<Line<T>> for LineString<T> where
    T: Float, 

fn contains(&self, line: &Line<T>) -> bool

Checks if the geometry A is completely inside the B geometry.

impl<T> Contains<LineString<T>> for Polygon<T> where
    T: Float, 

fn contains(&self, linestring: &LineString<T>) -> bool

Checks if the geometry A is completely inside the B geometry.

impl<T> Intersects<LineString<T>> for Line<T> where
    T: Float, 

fn intersects(&self, linestring: &LineString<T>) -> bool

Checks if the geometry A intersects the geometry B.

impl<T> Intersects<Line<T>> for LineString<T> where
    T: Float, 

fn intersects(&self, line: &Line<T>) -> bool

Checks if the geometry A intersects the geometry B.

impl<T> Intersects<LineString<T>> for LineString<T> where
    T: Float, 

fn intersects(&self, linestring: &LineString<T>) -> bool

Checks if the geometry A intersects the geometry B.

impl<T> Intersects<LineString<T>> for Polygon<T> where
    T: Float, 

fn intersects(&self, linestring: &LineString<T>) -> bool

Checks if the geometry A intersects the geometry B.

impl<T> EuclideanLength<T> for LineString<T> where
    T: Float, 

fn euclidean_length(&self) -> T

Calculation of the length of a Line

impl<T> EuclideanDistance<T, LineString<T>> for Point<T> where
    T: Float, 

fn euclidean_distance(&self, linestring: &LineString<T>) -> T

Minimum distance from a Point to a LineString

impl<T> EuclideanDistance<T, Point<T>> for LineString<T> where
    T: Float, 

fn euclidean_distance(&self, point: &Point<T>) -> T

Minimum distance from a LineString to a Point

impl<T> BoundingBox<T> for LineString<T> where
    T: CoordinateType, 

type Output = Option<Bbox<T>>

fn bbox(&self) -> Self::Output

Return the BoundingBox for a LineString

impl<T> Simplify<T> for LineString<T> where
    T: Float, 

fn simplify(&self, epsilon: &T) -> LineString<T>

Returns the simplified representation of a geometry, using the Ramer–Douglas–Peucker algorithm

impl<T> SimplifyVWPreserve<T> for LineString<T> where
    T: Float + SpadeFloat, 

fn simplifyvw_preserve(&self, epsilon: &T) -> LineString<T>

Returns the simplified representation of a geometry, using a topology-preserving variant of the Visvalingam-Whyatt algorithm.

impl<T> SimplifyVW<T> for LineString<T> where
    T: Float, 

fn simplifyvw(&self, epsilon: &T) -> LineString<T>

Returns the simplified representation of a geometry, using the Visvalingam-Whyatt algorithm

impl<T> ConvexHull<T> for LineString<T> where
    T: Float, 

fn convex_hull(&self) -> Polygon<T>

Returns the convex hull of a Polygon. The hull is always oriented counter-clockwise.

impl<T> Rotate<T> for LineString<T> where
    T: Float, 

fn rotate(&self, angle: T) -> Self

Rotate the LineString about its centroid by the given number of degrees

impl<T: CoordinateType, NT: CoordinateType> MapCoords<T, NT> for LineString<T>

type Output = LineString<NT>

fn map_coords(&self, func: &Fn(&(T, T)) -> (NT, NT)) -> Self::Output

Apply a function to all the coordinates in a geometric object, returning a new object.

impl<T: CoordinateType, NT: CoordinateType> TryMapCoords<T, NT> for LineString<T>

type Output = LineString<NT>

fn try_map_coords(
    &self,
    func: &Fn(&(T, T)) -> Result<(NT, NT), Error>
) -> Result<Self::Output, Error>

Map a fallible function over all the coordinates in a geometry, returning a Result

impl<T: CoordinateType> MapCoordsInplace<T> for LineString<T>

fn map_coords_inplace(&mut self, func: &Fn(&(T, T)) -> (T, T))

Apply a function to all the coordinates in a geometric object, in place

impl<F: Float> ClosestPoint<F> for LineString<F>

fn closest_point(&self, p: &Point<F>) -> Closest<F>

Find the closest point between self and p.

impl<T> HaversineLength<T> for LineString<T> where
    T: Float + FromPrimitive, 

fn haversine_length(&self) -> T

Calculation of the length of a Line

impl<T> Winding<T> for LineString<T> where
    T: CoordinateType, 

fn winding_order(&self) -> Option<WindingOrder>

Returns the winding order of this line None if the winding order is undefined.

Important traits for Box<W>

impl<W> Write for Box<W> where
    W: Write + ?Sized, impl<R> Read for Box<R> where
    R: Read + ?Sized, impl<I> Iterator for Box<I> where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

fn points_cw<'a>(&'a self) -> Box<Iterator<Item = &'a Point<T>> + 'a>

Iterate over the points in a clockwise order

The Linestring isn't changed, and the points are returned either in order, or in reverse order, so that the resultant order makes it appear clockwise

Important traits for Box<W>

impl<W> Write for Box<W> where
    W: Write + ?Sized, impl<R> Read for Box<R> where
    R: Read + ?Sized, impl<I> Iterator for Box<I> where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

fn points_ccw<'a>(&'a self) -> Box<Iterator<Item = &'a Point<T>> + 'a>

Iterate over the points in a counter-clockwise order

The Linestring isn't changed, and the points are returned either in order, or in reverse order, so that the resultant order makes it appear counter-clockwise

fn make_cw_winding(&mut self)

Change this line's points so they are in clockwise winding order

fn make_ccw_winding(&mut self)

Change this line's points so they are in counterclockwise winding order

fn is_cw(&self) -> bool

True iff this clockwise

fn is_ccw(&self) -> bool

True iff this is wound counterclockwise

fn clone_to_winding_order(&self, winding_order: WindingOrder) -> Self where
    Self: Sized + Clone, 

Return a clone of this object, but in the specified winding order

fn make_winding_order(&mut self, winding_order: WindingOrder)

Change the winding order so that it is in this winding order