Struct geo::LineString

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

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

Examples

Create a LineString by calling it directly:

use geo_types::{Coordinate, LineString};

let line_string = LineString(vec![
    Coordinate { x: 0., y: 0. },
    Coordinate { x: 10., y: 0. },
]);

Converting a Vec of Coordinate-like things:

use geo_types::LineString;

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

use geo_types::LineString;

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

Or collecting from a Coordinate iterator

use geo_types::{Coordinate, LineString};

let mut coords_iter =
    vec![Coordinate { x: 0., y: 0. }, Coordinate { x: 10., y: 0. }].into_iter();

let line_string: LineString<f32> = coords_iter.collect();

You can iterate over the coordinates in the LineString:

use geo_types::{Coordinate, LineString};

let line_string = LineString(vec![
    Coordinate { x: 0., y: 0. },
    Coordinate { x: 10., y: 0. },
]);

for coord in line_string {
    println!("Coordinate x = {}, y = {}", coord.x, coord.y);
}

You can also iterate over the coordinates in the LineString as Points:

use geo_types::{Coordinate, LineString};

let line_string = LineString(vec![
    Coordinate { x: 0., y: 0. },
    Coordinate { x: 10., y: 0. },
]);

for point in line_string.points_iter() {
    println!("Point x = {}, y = {}", point.x(), point.y());
}

Implementations

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

pub fn points_iter(&self) -> PointsIter<'_, T>

Return an iterator yielding the coordinates of a LineString as Points

pub fn into_points(self) -> Vec<Point<T>>

Return the coordinates of a LineString as a Vec of Points

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

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

Examples

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

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

let mut lines = line_string.lines();
assert_eq!(
    Some(Line::new(
        Coordinate { x: 0., y: 0. },
        Coordinate { x: 5., y: 0. }
    )),
    lines.next()
);
assert_eq!(
    Some(Line::new(
        Coordinate { x: 5., y: 0. },
        Coordinate { x: 7., y: 9. }
    )),
    lines.next()
);
assert!(lines.next().is_none());

pub fn triangles(
    &'a self
) -> impl ExactSizeIterator + Iterator<Item = Triangle<T>> + 'a

An iterator which yields the coordinates of a LineString as Triangles

pub fn num_coords(&self) -> usize

Return the number of coordinates in the LineString.

Examples

use geo_types::LineString;

let mut coords = vec![(0., 0.), (5., 0.), (7., 9.)];
let line_string: LineString<f32> = coords.into_iter().collect();
assert_eq!(3, line_string.num_coords());

Trait Implementations

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

fn signed_area(&self) -> T

fn unsigned_area(&self) -> T

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

type Output = Option<Rect<T>>

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

Return the BoundingRect for a LineString

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> 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<F: Float> ClosestPoint<F, Point<F>> for LineString<F>

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

Find the closest point between self and p.

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

fn contains(&self, coord: &Coordinate<T>) -> bool

Checks if rhs is completely contained within self.

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

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

Checks if rhs is completely contained within self.

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

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

Checks if rhs is completely contained within self.

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

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

Checks if rhs is completely contained within self.

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

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

Checks if rhs is completely contained within self.

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

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

Formats the value using the given formatter.

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

impl<T> EuclideanDistance<T, Line<T>> for LineString<T> where
    T: Float + FloatConst + Signed + RTreeNum, 

LineString to Line

fn euclidean_distance(&self, other: &Line<T>) -> T

Returns the distance between two geometries

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, LineString<T>> for LineString<T> where
    T: Float + Signed + RTreeNum, 

LineString-LineString distance

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

Returns the distance between two geometries

impl<T> EuclideanDistance<T, LineString<T>> for Line<T> where
    T: Float + FloatConst + Signed + RTreeNum, 

Line to LineString

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

Returns the distance between two geometries

impl<T> EuclideanDistance<T, LineString<T>> for Polygon<T> where
    T: Float + FloatConst + Signed + RTreeNum, 

Polygon to LineString distance

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

Returns the distance between two geometries

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> EuclideanDistance<T, Polygon<T>> for LineString<T> where
    T: Float + FloatConst + Signed + RTreeNum, 

LineString to Polygon

fn euclidean_distance(&self, other: &Polygon<T>) -> T

Returns the distance between two geometries

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

fn euclidean_length(&self) -> T

Calculation of the length of a Line

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

fn frechet_distance(&self, ls: &LineString<T>) -> T

Determine the similarity between two LineStrings using the [Frechet distance].

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

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

Performs the conversion.

impl<T, IC> From<Vec<IC>> for LineString<T> where
    IC: Into<Coordinate<T>>,
    T: CoordinateType, 

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

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

Performs the conversion.

impl<T, IC> FromIterator<IC> for LineString<T> where
    IC: Into<Coordinate<T>>,
    T: CoordinateType, 

Turn an iterator of Point-like objects into a LineString.

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

Creates a value from an iterator.

impl GeodesicLength<f64, LineString<f64>> for LineString<f64>

fn geodesic_length(&self) -> f64

Determine the length of a geometry on an ellipsoidal model of the earth.

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

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, 

Feeds a slice of this type into the given [Hasher].

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

fn haversine_length(&self) -> T

Determine the length of a geometry using the [haversine formula].

impl<T> Index<usize> for LineString<T> where
    T: CoordinateType, 

type Output = Coordinate<T>

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<T> IndexMut<usize> for LineString<T> where
    T: CoordinateType, 

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

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

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 Line<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 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> Intersects<Polygon<T>> for LineString<T> where
    T: Float, 

fn intersects(&self, polygon: &Polygon<T>) -> bool

Checks if the geometry A intersects the geometry B.

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

Iterate over all the Coordinates in this LineString.

type Item = Coordinate<T>

The type of the elements being iterated over.

type IntoIter = IntoIter<Coordinate<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<'a, T> IntoIterator for &'a mut LineString<T> where
    T: CoordinateType, 

Mutably iterate over all the Coordinates in this LineString.

type Item = &'a mut Coordinate<T>

The type of the elements being iterated over.

type IntoIter = IterMut<'a, Coordinate<T>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> IterMut<'a, Coordinate<T>>

Creates an iterator from a value.

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

type Output = LineString<NT>

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

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

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

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

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

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

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

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

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

This method tests for !=.

impl<T> PointDistance for LineString<T> where
    T: Float + RTreeNum, 

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

Returns the squared euclidean distance of an object to a point.

fn contains_point(&self, point: &<Self::Envelope as Envelope>::Point) -> bool

Returns true if a point is contained within this object.

fn distance_2_if_less_or_equal(
    &self,
    point: &<Self::Envelope as Envelope>::Point,
    max_distance_2: <<Self::Envelope as Envelope>::Point as Point>::Scalar
) -> Option<<<Self::Envelope as Envelope>::Point as Point>::Scalar>

Returns the squared distance to this object or None if the distance is larger than a given maximum value.

impl<T> RTreeObject for LineString<T> where
    T: Float + RTreeNum, 

type Envelope = AABB<Point<T>>

The object's envelope type. Usually, AABB will be the right choice. This type also defines the objects dimensionality.

fn envelope(&self) -> <LineString<T> as RTreeObject>::Envelope

Returns the object's envelope.

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

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

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

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

fn simplify_idx(&self, epsilon: &T) -> Vec<usize>

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

impl<T> SimplifyVW<T, 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> SimplifyVWPreserve<T, T> for LineString<T> where
    T: Float + RTreeNum, 

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

fn simplifyvw_idx(&self, epsilon: &T) -> Vec<usize>

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

impl<T> TryFrom<Geometry<T>> for LineString<T> where
    T: Float, 

type Error = FailedToConvertError

The type returned in the event of a conversion error.

fn try_from(
    geom: Geometry<T>
) -> Result<LineString<T>, <LineString<T> as TryFrom<Geometry<T>>>::Error>

Performs the conversion.

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

type Output = LineString<NT>

fn try_map_coords(
    &self,
    func: impl Fn(&(T, T)) -> Result<(NT, NT), Box<dyn Error + Send + Sync>> + Copy
) -> Result<Self::Output, Box<dyn Error + Send + Sync>>

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

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

fn vincenty_length(&self) -> Result<T, FailedToConvergeError>

Determine the length of a geometry using [Vincenty’s formulae].

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.

fn points_cw(&self) -> Points<'_, T>

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

fn points_ccw(&self) -> Points<'_, T>

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