Struct geo::LineString

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

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

Create a LineString by calling it directly:

use geo::{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::{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: Float> LineString<T>

fn lines<'a>(&'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::{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());

Trait Implementations

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

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: Clone> Clone for LineString<T> where
    T: Float, 

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> Debug for LineString<T> where
    T: Float, 

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

Formats the value using the given formatter.

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

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

fn from(v: Vec<IP>) -> Self

Performs the conversion.

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

Turn a Point-ish iterator into a LineString.

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

Creates a value from an iterator.

impl<T: Float> IntoIterator for LineString<T>

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

Creates an iterator from a value.

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<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> 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> Length<T> for LineString<T> where
    T: Float, 

fn length(&self) -> T

Calculation of the length of a Line

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

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

Minimum distance from a LineString to a Point

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

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: Float, NT: Float> 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<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<'a, T> FromPostgis<&'a T> for LineString<f64> where
    T: LineString<'a>, 

fn from_postgis(ls: &'a T) -> Self

impl ToPostgis<LineString> for LineString<f64>

fn to_postgis_with_srid(&self, srid: Option<i32>) -> LineString

Converts this geometry to a PostGIS type, using the supplied SRID.

fn to_postgis_wgs84(&self) -> T

Converts this WGS84 geometry to a PostGIS type.

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

fn haversine_length(&self) -> T

Calculation of the length of a Line