Struct Line

pub struct Line<T = f64>
where
    T: CoordNum,
{
    pub start: Coord<T>,
    pub end: Coord<T>,
}

A line segment made up of exactly two Coords.

Semantics

The interior and boundary are defined as with a LineString with the two end points.

Fields

start: Coord<T>

end: Coord<T>

Implementations

impl<T> Line<T>

where T: CoordNum,

pub fn new<C>(start: C, end: C) -> Line<T>

where C: Into<Coord<T>>,

Creates a new line segment.

Examples

use geo_types::{coord, Line};

let line = Line::new(coord! { x: 0., y: 0. }, coord! { x: 1., y: 2. });

assert_eq!(line.start, coord! { x: 0., y: 0. });
assert_eq!(line.end, coord! { x: 1., y: 2. });

pub fn delta(&self) -> Coord<T>

Calculate the difference in coordinates (Δx, Δy).

pub fn dx(&self) -> T

Calculate the difference in ‘x’ components (Δx).

Equivalent to:

line.end.x - line.start.x

pub fn dy(&self) -> T

Calculate the difference in ‘y’ components (Δy).

Equivalent to:

line.end.y - line.start.y

pub fn slope(&self) -> T

Calculate the slope (Δy/Δx).

Equivalent to:

line.dy() / line.dx()

Note that:

Line::new(a, b).slope() == Line::new(b, a).slope()

pub fn determinant(&self) -> T

Calculate the determinant of the line.

Equivalent to:

line.start.x * line.end.y - line.start.y * line.end.x

Note that:

Line::new(a, b).determinant() == -Line::new(b, a).determinant()

pub fn start_point(&self) -> Point<T>

pub fn end_point(&self) -> Point<T>

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

Trait Implementations

impl<T> AbsDiffEq for Line<T>

where T: CoordNum + AbsDiffEq<Epsilon = T>,

fn abs_diff_eq( &self, other: &Line<T>, epsilon: <Line<T> as AbsDiffEq>::Epsilon, ) -> bool

Equality assertion with an absolute limit.

Examples

use geo_types::{coord, Line};

let a = Line::new(coord! { x: 0., y: 0. }, coord! { x: 1., y: 1. });
let b = Line::new(coord! { x: 0., y: 0. }, coord! { x: 1.001, y: 1. });

approx::assert_abs_diff_eq!(a, b, epsilon=0.1);

type Epsilon = T

Used for specifying relative comparisons.

fn default_epsilon() -> <Line<T> as AbsDiffEq>::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> Area<T> for Line<T>

where T: CoordNum,

fn signed_area(&self) -> T

fn unsigned_area(&self) -> T

impl<T> BoundingRect<T> for Line<T>

where T: CoordNum,

type Output = Rect<T>

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

Return the bounding rectangle of a geometry

impl<T> Centroid for Line<T>

where T: GeoFloat,

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

The Centroid of a Line is its middle point

Examples

use geo::Centroid;
use geo::{Line, point};

let line = Line::new(
    point!(x: 1.0f64, y: 3.0),
    point!(x: 2.0f64, y: 4.0),
);

assert_eq!(
    point!(x: 1.5, y: 3.5),
    line.centroid(),
);

type Output = Point<T>

impl<T> ChamberlainDuquetteArea<T> for Line<T>

where T: CoordFloat,

fn chamberlain_duquette_signed_area(&self) -> T

fn chamberlain_duquette_unsigned_area(&self) -> T

impl<T> Clone for Line<T>

where T: Clone + CoordNum,

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F: GeoFloat> ClosestPoint<F> for Line<F>

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

Find the closest point between self and p.

impl<T> Contains<Coord<T>> for Line<T>

where T: GeoNum,

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

impl<T> Contains<Geometry<T>> for Line<T>

where T: GeoFloat,

fn contains(&self, geometry: &Geometry<T>) -> bool

impl<T> Contains<GeometryCollection<T>> for Line<T>

where T: GeoFloat,

fn contains(&self, target: &GeometryCollection<T>) -> bool

impl<F> Contains<Line<F>> for MultiPolygon<F>

where F: GeoFloat,

fn contains(&self, rhs: &Line<F>) -> bool

impl<T> Contains<Line<T>> for Geometry<T>

where T: GeoFloat,

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

impl<T> Contains<Line<T>> for GeometryCollection<T>

where T: GeoFloat,

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

impl<T> Contains<Line<T>> for LineString<T>

where T: GeoNum,

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

impl<T> Contains<Line<T>> for MultiLineString<T>

where T: GeoFloat,

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

impl<T> Contains<Line<T>> for MultiPoint<T>

where T: GeoFloat,

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

impl<T> Contains<Line<T>> for Point<T>

where T: CoordNum,

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

impl<T> Contains<Line<T>> for Polygon<T>

where T: GeoFloat,

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

impl<T> Contains<Line<T>> for Rect<T>

where T: GeoFloat,

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

impl<T> Contains<Line<T>> for Triangle<T>

where T: GeoFloat,

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

impl<T> Contains<LineString<T>> for Line<T>

where T: GeoNum,

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

impl<T> Contains<MultiLineString<T>> for Line<T>

where T: GeoFloat,

fn contains(&self, target: &MultiLineString<T>) -> bool

impl<T> Contains<MultiPoint<T>> for Line<T>

where T: GeoFloat,

fn contains(&self, target: &MultiPoint<T>) -> bool

impl<T> Contains<MultiPolygon<T>> for Line<T>

where T: GeoFloat,

fn contains(&self, target: &MultiPolygon<T>) -> bool

impl<T> Contains<Point<T>> for Line<T>

where T: GeoNum,

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

impl<T> Contains<Polygon<T>> for Line<T>

where T: GeoFloat,

fn contains(&self, target: &Polygon<T>) -> bool

impl<T> Contains<Rect<T>> for Line<T>

where T: GeoFloat,

fn contains(&self, target: &Rect<T>) -> bool

impl<T> Contains<Triangle<T>> for Line<T>

where T: GeoFloat,

fn contains(&self, target: &Triangle<T>) -> bool

impl<T> Contains for Line<T>

where T: GeoNum,

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

impl<T> CoordinatePosition for Line<T>

where T: GeoNum,

type Scalar = T

fn calculate_coordinate_position( &self, coord: &Coord<T>, is_inside: &mut bool, boundary_count: &mut usize, )

fn coordinate_position(&self, coord: &Coord<Self::Scalar>) -> CoordPos

impl<T: CoordNum> CoordsIter for Line<T>

fn coords_count(&self) -> usize

Return the number of coordinates in the Line.

type Iter<'a> = Chain<Once<Coord<T>>, Once<Coord<T>>> where T: 'a

type ExteriorIter<'a> = <Line<T> as CoordsIter>::Iter<'a> where T: 'a

type Scalar = T

fn coords_iter(&self) -> Self::Iter<'_>

Iterate over all exterior and (if any) interior coordinates of a geometry.

fn exterior_coords_iter(&self) -> Self::ExteriorIter<'_>

Iterate over all exterior coordinates of a geometry.

impl<T: GeoFloat> Cross for Line<T>

type Scalar = T

Scalar used the coordinates.

fn line(&self) -> LineOrPoint<Self::Scalar>

The geometry associated with this type. Use a Line with the start and end coordinates to represent a point.

impl<T> Debug for Line<T>

where T: CoordNum,

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

Formats the value using the given formatter.

impl<F: CoordFloat + FromPrimitive> Densifiable<F> for Line<F>

type Output = LineString<F>

fn densify<MetricSpace>( &self, metric_space: &MetricSpace, max_segment_length: F, ) -> Self::Output

where MetricSpace: Distance<F, Point<F>, Point<F>> + InterpolatePoint<F>,

impl<T> DensifyHaversine<T> for Line<T>

where T: CoordFloat + FromPrimitive, Line<T>: HaversineLength<T>, LineString<T>: HaversineLength<T>,

type Output = LineString<T>

👎Deprecated since 0.29.0: Please use the Haversine.densify(&line) via the Densify trait instead.

fn densify_haversine(&self, max_distance: T) -> Self::Output

👎Deprecated since 0.29.0: Please use the Haversine.densify(&line) via the Densify trait instead.

impl<F> Distance<F, &Geometry<F>, &Line<F>> for Euclidean

where F: GeoFloat,

fn distance(&self, a: &Geometry<F>, b: &Line<F>) -> F

Note that not all implementations support all geometry combinations, but at least Point to Point is supported. See specific implementations for details.

impl<F: GeoFloat> Distance<F, &GeometryCollection<F>, &Line<F>> for Euclidean

fn distance( &self, iter_geometry: &GeometryCollection<F>, to_geometry: &Line<F>, ) -> F

Note that not all implementations support all geometry combinations, but at least Point to Point is supported. See specific implementations for details.

impl<F: GeoFloat> Distance<F, &Line<F>, &Geometry<F>> for Euclidean

fn distance(&self, origin: &Line<F>, destination: &Geometry<F>) -> F

Note that not all implementations support all geometry combinations, but at least Point to Point is supported. See specific implementations for details.

impl<F> Distance<F, &Line<F>, &GeometryCollection<F>> for Euclidean

where F: GeoFloat,

fn distance(&self, a: &Line<F>, b: &GeometryCollection<F>) -> F

Note that not all implementations support all geometry combinations, but at least Point to Point is supported. See specific implementations for details.

impl<F: GeoFloat> Distance<F, &Line<F>, &Line<F>> for Euclidean

fn distance(&self, line_a: &Line<F>, line_b: &Line<F>) -> F

Note that not all implementations support all geometry combinations, but at least Point to Point is supported. See specific implementations for details.

impl<F: GeoFloat> Distance<F, &Line<F>, &LineString<F>> for Euclidean

fn distance(&self, line: &Line<F>, line_string: &LineString<F>) -> F

Note that not all implementations support all geometry combinations, but at least Point to Point is supported. See specific implementations for details.

impl<F> Distance<F, &Line<F>, &MultiLineString<F>> for Euclidean

where F: GeoFloat,

fn distance(&self, a: &Line<F>, b: &MultiLineString<F>) -> F

Note that not all implementations support all geometry combinations, but at least Point to Point is supported. See specific implementations for details.

impl<F> Distance<F, &Line<F>, &MultiPoint<F>> for Euclidean

where F: GeoFloat,

fn distance(&self, a: &Line<F>, b: &MultiPoint<F>) -> F

Note that not all implementations support all geometry combinations, but at least Point to Point is supported. See specific implementations for details.

impl<F> Distance<F, &Line<F>, &MultiPolygon<F>> for Euclidean

where F: GeoFloat,

fn distance(&self, a: &Line<F>, b: &MultiPolygon<F>) -> F

Note that not all implementations support all geometry combinations, but at least Point to Point is supported. See specific implementations for details.

impl<F> Distance<F, &Line<F>, &Point<F>> for Euclidean

where F: CoordFloat,

fn distance(&self, a: &Line<F>, b: &Point<F>) -> F

Note that not all implementations support all geometry combinations, but at least Point to Point is supported. See specific implementations for details.

impl<F: GeoFloat> Distance<F, &Line<F>, &Polygon<F>> for Euclidean

fn distance(&self, line: &Line<F>, polygon: &Polygon<F>) -> F

Note that not all implementations support all geometry combinations, but at least Point to Point is supported. See specific implementations for details.

impl<F> Distance<F, &Line<F>, &Rect<F>> for Euclidean

where F: GeoFloat,

fn distance(&self, a: &Line<F>, b: &Rect<F>) -> F

Note that not all implementations support all geometry combinations, but at least Point to Point is supported. See specific implementations for details.

impl<F> Distance<F, &Line<F>, &Triangle<F>> for Euclidean

where F: GeoFloat,

fn distance(&self, a: &Line<F>, b: &Triangle<F>) -> F

Note that not all implementations support all geometry combinations, but at least Point to Point is supported. See specific implementations for details.

impl<F> Distance<F, &Line<F>, Coord<F>> for Euclidean

where F: CoordFloat,

fn distance(&self, a: &Line<F>, b: Coord<F>) -> F

Note that not all implementations support all geometry combinations, but at least Point to Point is supported. See specific implementations for details.

impl<F> Distance<F, &LineString<F>, &Line<F>> for Euclidean

where F: GeoFloat,

fn distance(&self, a: &LineString<F>, b: &Line<F>) -> F

Note that not all implementations support all geometry combinations, but at least Point to Point is supported. See specific implementations for details.

impl<F: GeoFloat> Distance<F, &MultiLineString<F>, &Line<F>> for Euclidean

fn distance( &self, iter_geometry: &MultiLineString<F>, to_geometry: &Line<F>, ) -> F

Note that not all implementations support all geometry combinations, but at least Point to Point is supported. See specific implementations for details.

impl<F: GeoFloat> Distance<F, &MultiPoint<F>, &Line<F>> for Euclidean

fn distance(&self, iter_geometry: &MultiPoint<F>, to_geometry: &Line<F>) -> F

Note that not all implementations support all geometry combinations, but at least Point to Point is supported. See specific implementations for details.

impl<F: GeoFloat> Distance<F, &MultiPolygon<F>, &Line<F>> for Euclidean

fn distance(&self, iter_geometry: &MultiPolygon<F>, to_geometry: &Line<F>) -> F

Note that not all implementations support all geometry combinations, but at least Point to Point is supported. See specific implementations for details.

impl<F: CoordFloat> Distance<F, &Point<F>, &Line<F>> for Euclidean

fn distance(&self, origin: &Point<F>, destination: &Line<F>) -> F

Note that not all implementations support all geometry combinations, but at least Point to Point is supported. See specific implementations for details.

impl<F> Distance<F, &Polygon<F>, &Line<F>> for Euclidean

where F: GeoFloat,

fn distance(&self, a: &Polygon<F>, b: &Line<F>) -> F

Note that not all implementations support all geometry combinations, but at least Point to Point is supported. See specific implementations for details.

impl<F: GeoFloat> Distance<F, &Rect<F>, &Line<F>> for Euclidean

fn distance(&self, polygonlike: &Rect<F>, geometry_b: &Line<F>) -> F

Note that not all implementations support all geometry combinations, but at least Point to Point is supported. See specific implementations for details.

impl<F: GeoFloat> Distance<F, &Triangle<F>, &Line<F>> for Euclidean

fn distance(&self, polygonlike: &Triangle<F>, geometry_b: &Line<F>) -> F

Note that not all implementations support all geometry combinations, but at least Point to Point is supported. See specific implementations for details.

impl<F: CoordFloat> Distance<F, Coord<F>, &Line<F>> for Euclidean

fn distance(&self, coord: Coord<F>, line: &Line<F>) -> F

Note that not all implementations support all geometry combinations, but at least Point to Point is supported. See specific implementations for details.

impl<T> EuclideanDistance<T> for Line<T>

where T: GeoFloat + FloatConst + Signed + RTreeNum,

Line to Line distance

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

👎Deprecated since 0.29.0: Please use the Euclidean.distance method from the Distance trait instead

Returns the distance between two geometries

impl<T> EuclideanDistance<T, Coord<T>> for Line<T>

where T: GeoFloat,

fn euclidean_distance(&self, coord: &Coord<T>) -> T

👎Deprecated since 0.29.0: Please use the Euclidean.distance method from the Distance trait instead

Minimum distance from a Line to a Coord

impl<T> EuclideanDistance<T, Geometry<T>> for Line<T>

where T: GeoFloat + FloatConst + RTreeNum,

fn euclidean_distance(&self, geom: &Geometry<T>) -> T

👎Deprecated since 0.29.0: Please use the Euclidean.distance method from the Distance trait instead

Returns the distance between two geometries

impl<T> EuclideanDistance<T, GeometryCollection<T>> for Line<T>

where T: GeoFloat + FloatConst + RTreeNum,

fn euclidean_distance(&self, target: &GeometryCollection<T>) -> T

👎Deprecated since 0.29.0: Please use the Euclidean.distance method from the Distance trait instead

Returns the distance between two geometries

impl<T> EuclideanDistance<T, Line<T>> for Coord<T>

where T: GeoFloat,

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

👎Deprecated since 0.29.0: Please use the Euclidean.distance method from the Distance trait instead

Minimum distance from a Coord to a Line

impl<T> EuclideanDistance<T, Line<T>> for Geometry<T>

where T: GeoFloat + FloatConst + RTreeNum,

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

👎Deprecated since 0.29.0: Please use the Euclidean.distance method from the Distance trait instead

Returns the distance between two geometries

impl<T> EuclideanDistance<T, Line<T>> for GeometryCollection<T>

where T: GeoFloat + FloatConst + RTreeNum,

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

👎Deprecated since 0.29.0: Please use the Euclidean.distance method from the Distance trait instead

Returns the distance between two geometries

impl<T> EuclideanDistance<T, Line<T>> for LineString<T>

where T: GeoFloat + FloatConst + Signed + RTreeNum,

LineString to Line

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

👎Deprecated since 0.29.0: Please use the Euclidean.distance method from the Distance trait instead

Returns the distance between two geometries

impl<T> EuclideanDistance<T, Line<T>> for MultiLineString<T>

where T: GeoFloat + FloatConst + RTreeNum,

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

👎Deprecated since 0.29.0: Please use the Euclidean.distance method from the Distance trait instead

Returns the distance between two geometries

impl<T> EuclideanDistance<T, Line<T>> for MultiPoint<T>

where T: GeoFloat + FloatConst + RTreeNum,

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

👎Deprecated since 0.29.0: Please use the Euclidean.distance method from the Distance trait instead

Returns the distance between two geometries

impl<T> EuclideanDistance<T, Line<T>> for MultiPolygon<T>

where T: GeoFloat + FloatConst + RTreeNum,

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

👎Deprecated since 0.29.0: Please use the Euclidean.distance method from the Distance trait instead

Returns the distance between two geometries

impl<T> EuclideanDistance<T, Line<T>> for Point<T>

where T: GeoFloat,

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

👎Deprecated since 0.29.0: Please use the Euclidean.distance method from the Distance trait instead

Minimum distance from a Line to a Point

impl<T> EuclideanDistance<T, Line<T>> for Polygon<T>

where T: GeoFloat + FloatConst + Signed + RTreeNum,

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

👎Deprecated since 0.29.0: Please use the Euclidean.distance method from the Distance trait instead

Returns the distance between two geometries

impl<T> EuclideanDistance<T, Line<T>> for Rect<T>

where T: GeoFloat + Signed + RTreeNum + FloatConst,

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

👎Deprecated since 0.29.0: Please use the Euclidean.distance method from the Distance trait instead

Returns the distance between two geometries

impl<T> EuclideanDistance<T, Line<T>> for Triangle<T>

where T: GeoFloat + Signed + RTreeNum + FloatConst,

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

👎Deprecated since 0.29.0: Please use the Euclidean.distance method from the Distance trait instead

Returns the distance between two geometries

impl<T> EuclideanDistance<T, LineString<T>> for Line<T>

where T: GeoFloat + FloatConst + Signed + RTreeNum,

Line to LineString

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

👎Deprecated since 0.29.0: Please use the Euclidean.distance method from the Distance trait instead

Returns the distance between two geometries

impl<T> EuclideanDistance<T, MultiLineString<T>> for Line<T>

where T: GeoFloat + FloatConst + RTreeNum,

fn euclidean_distance(&self, target: &MultiLineString<T>) -> T

👎Deprecated since 0.29.0: Please use the Euclidean.distance method from the Distance trait instead

Returns the distance between two geometries

impl<T> EuclideanDistance<T, MultiPoint<T>> for Line<T>

where T: GeoFloat + FloatConst + RTreeNum,

fn euclidean_distance(&self, target: &MultiPoint<T>) -> T

👎Deprecated since 0.29.0: Please use the Euclidean.distance method from the Distance trait instead

Returns the distance between two geometries

impl<T> EuclideanDistance<T, MultiPolygon<T>> for Line<T>

where T: GeoFloat + FloatConst + RTreeNum,

fn euclidean_distance(&self, target: &MultiPolygon<T>) -> T

👎Deprecated since 0.29.0: Please use the Euclidean.distance method from the Distance trait instead

Returns the distance between two geometries

impl<T> EuclideanDistance<T, Point<T>> for Line<T>

where T: GeoFloat,

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

👎Deprecated since 0.29.0: Please use the Euclidean.distance method from the Distance trait instead

Minimum distance from a Line to a Point

impl<T> EuclideanDistance<T, Polygon<T>> for Line<T>

where T: GeoFloat + Signed + RTreeNum + FloatConst,

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

👎Deprecated since 0.29.0: Please use the Euclidean.distance method from the Distance trait instead

Returns the distance between two geometries

impl<T> EuclideanDistance<T, Rect<T>> for Line<T>

where T: GeoFloat + Signed + RTreeNum + FloatConst,

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

👎Deprecated since 0.29.0: Please use the Euclidean.distance method from the Distance trait instead

Returns the distance between two geometries

impl<T> EuclideanDistance<T, Triangle<T>> for Line<T>

where T: GeoFloat + Signed + RTreeNum + FloatConst,

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

👎Deprecated since 0.29.0: Please use the Euclidean.distance method from the Distance trait instead

Returns the distance between two geometries

impl<T> EuclideanLength<T> for Line<T>

where T: CoordFloat,

fn euclidean_length(&self) -> T

👎Deprecated since 0.29.0: Please use the Euclidean.length(&line) via the Length trait instead.

Calculation of the length of a Line

impl<'a, F: GeoFloat> From<&'a Line<F>> for PreparedGeometry<'a, &'a Line<F>, F>

fn from(geometry: &'a Line<F>) -> Self

Converts to this type from the input type.

impl<T> From<&Line<T>> for LineString<T>

where T: CoordNum,

fn from(line: &Line<T>) -> LineString<T>

Converts to this type from the input type.

impl<T> From<[(T, T); 2]> for Line<T>

where T: CoordNum,

fn from(coord: [(T, T); 2]) -> Line<T>

Converts to this type from the input type.

impl<F: GeoFloat> From<Line<F>> for PreparedGeometry<'static, Line<F>, F>

fn from(geometry: Line<F>) -> Self

Converts to this type from the input type.

impl<T> From<Line<T>> for Geometry<T>

where T: CoordNum,

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

Converts to this type from the input type.

impl<T: GeoNum> From<Line<T>> for LineOrPoint<T>

Convert from a Line ensuring end point ordering.

fn from(l: Line<T>) -> Self

Converts to this type from the input type.

impl<T> From<Line<T>> for LineString<T>

where T: CoordNum,

fn from(line: Line<T>) -> LineString<T>

Converts to this type from the input type.

impl GeodesicArea<f64> for Line

fn geodesic_perimeter(&self) -> f64

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

fn geodesic_area_signed(&self) -> f64

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

fn geodesic_area_unsigned(&self) -> f64

Determine the area of a geometry on an ellipsoidal model of the earth. Supports very large geometries that cover a significant portion of the earth.

fn geodesic_perimeter_area_signed(&self) -> (f64, f64)

Determine the perimeter and area of a geometry on an ellipsoidal model of the earth, all in one operation.

fn geodesic_perimeter_area_unsigned(&self) -> (f64, f64)

Determine the perimeter and area of a geometry on an ellipsoidal model of the earth, all in one operation. Supports very large geometries that cover a significant portion of the earth.

impl GeodesicLength<f64> for Line

fn geodesic_length(&self) -> f64

👎Deprecated since 0.29.0: Please use the Geodesic.length(&line) via the Length trait instead.

The units of the returned value is meters.

impl<C: CoordNum> HasDimensions for Line<C>

fn is_empty(&self) -> bool

Some geometries, like a MultiPoint, can have zero coordinates - we call these empty.

fn dimensions(&self) -> Dimensions

The dimensions of some geometries are fixed, e.g. a Point always has 0 dimensions. However for others, the dimensionality depends on the specific geometry instance - for example typical Rects are 2-dimensional, but it’s possible to create degenerate Rects which have either 1 or 0 dimensions.

fn boundary_dimensions(&self) -> Dimensions

The dimensions of the Geometry’s boundary, as used by OGC-SFA.

impl<T> Hash for Line<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<T> HaversineClosestPoint<T> for Line<T>

where T: GeoFloat + FromPrimitive,

fn haversine_closest_point(&self, from: &Point<T>) -> Closest<T>

impl<T> HaversineLength<T> for Line<T>

where T: CoordFloat + FromPrimitive,

fn haversine_length(&self) -> T

👎Deprecated since 0.29.0: Please use the Haversine.length(&line) via the Length trait instead.

Determine the length of a geometry using the haversine formula.

impl<T> InteriorPoint for Line<T>

where T: GeoFloat,

type Output = Point<T>

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

Calculates a representative point inside the Geometry

impl<F: CoordFloat> InterpolatableLine<F> for Line<F>

type Output = Point<F>

fn point_at_ratio_from_start<MetricSpace: InterpolatePoint<F> + Length<F>>( &self, metric_space: &MetricSpace, ratio: F, ) -> Self::Output

Returns a new point part way down the line.

fn point_at_ratio_from_end<MetricSpace: InterpolatePoint<F> + Length<F>>( &self, metric_space: &MetricSpace, ratio: F, ) -> Self::Output

Returns a new point part way down the line, starting from the end of the line.

fn point_at_distance_from_start<MetricSpace: InterpolatePoint<F> + Length<F>>( &self, metric_space: &MetricSpace, distance: F, ) -> Self::Output

Returns a new point distance from the start of the line.

fn point_at_distance_from_end<MetricSpace: InterpolatePoint<F> + Length<F>>( &self, metric_space: &MetricSpace, distance: F, ) -> Self::Output

Returns a new point distance from the end of the line.

impl<T> Intersects<Coord<T>> for Line<T>

where T: GeoNum,

fn intersects(&self, rhs: &Coord<T>) -> bool

impl<T> Intersects<Geometry<T>> for Line<T>

where Geometry<T>: Intersects<Line<T>>, T: CoordNum,

fn intersects(&self, rhs: &Geometry<T>) -> bool

impl<T> Intersects<GeometryCollection<T>> for Line<T>

where GeometryCollection<T>: Intersects<Line<T>>, T: CoordNum,

fn intersects(&self, rhs: &GeometryCollection<T>) -> bool

impl<T> Intersects<Line<T>> for Coord<T>

where Line<T>: Intersects<Coord<T>>, T: CoordNum,

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

impl<T> Intersects<Line<T>> for Polygon<T>

where T: GeoNum,

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

impl<T> Intersects<Line<T>> for Rect<T>

where T: GeoNum,

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

impl<T> Intersects<Line<T>> for Triangle<T>

where Line<T>: Intersects<Triangle<T>>, T: CoordNum,

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

impl<T> Intersects<LineString<T>> for Line<T>

where LineString<T>: Intersects<Line<T>>, T: CoordNum,

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

impl<T> Intersects<MultiLineString<T>> for Line<T>

where MultiLineString<T>: Intersects<Line<T>>, T: CoordNum,

fn intersects(&self, rhs: &MultiLineString<T>) -> bool

impl<T> Intersects<MultiPoint<T>> for Line<T>

where MultiPoint<T>: Intersects<Line<T>>, T: CoordNum,

fn intersects(&self, rhs: &MultiPoint<T>) -> bool

impl<T> Intersects<MultiPolygon<T>> for Line<T>

where MultiPolygon<T>: Intersects<Line<T>>, T: CoordNum,

fn intersects(&self, rhs: &MultiPolygon<T>) -> bool

impl<T> Intersects<Point<T>> for Line<T>

where Point<T>: Intersects<Line<T>>, T: CoordNum,

fn intersects(&self, rhs: &Point<T>) -> bool

impl<T> Intersects<Polygon<T>> for Line<T>

where Polygon<T>: Intersects<Line<T>>, T: CoordNum,

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

impl<T> Intersects<Rect<T>> for Line<T>

where Rect<T>: Intersects<Line<T>>, T: CoordNum,

fn intersects(&self, rhs: &Rect<T>) -> bool

impl<T> Intersects<Triangle<T>> for Line<T>

where T: GeoNum,

fn intersects(&self, rhs: &Triangle<T>) -> bool

impl<T> Intersects for Line<T>

where T: GeoNum,

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

impl<F: CoordFloat> LengthMeasurable<F> for Line<F>

fn length(&self, metric_space: &impl Distance<F, Point<F>, Point<F>>) -> F

impl<T> LineInterpolatePoint<T> for Line<T>

where T: CoordFloat,

type Output = Option<Point<T>>

👎Deprecated since 0.30.0: use line_string.point_at_ratio_from_start(&Euclidean, fraction) instead

fn line_interpolate_point(&self, fraction: T) -> Self::Output

👎Deprecated since 0.30.0: use line_string.point_at_ratio_from_start(&Euclidean, fraction) instead

impl<T> LineLocatePoint<T, Point<T>> for Line<T>

where T: CoordFloat,

type Output = Option<T>

type Rhs = Point<T>

fn line_locate_point(&self, p: &Self::Rhs) -> Self::Output

impl<'a, T: CoordNum + 'a> LinesIter<'a> for Line<T>

type Scalar = T

type Iter = Copied<Once<&'a Line<<Line<T> as LinesIter<'a>>::Scalar>>>

fn lines_iter(&'a self) -> Self::Iter

Iterate over all exterior and (if any) interior lines of a geometry.

impl<T: CoordNum, NT: CoordNum> MapCoords<T, NT> for Line<T>

type Output = Line<NT>

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

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

fn try_map_coords<E>( &self, func: impl Fn(Coord<T>) -> Result<Coord<NT>, E> + Copy, ) -> Result<Self::Output, E>

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

impl<T: CoordNum> MapCoordsInPlace<T> for Line<T>

fn map_coords_in_place(&mut self, func: impl Fn(Coord<T>) -> Coord<T>)

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

fn try_map_coords_in_place<E>( &mut self, func: impl Fn(Coord<T>) -> Result<Coord<T>, E>, ) -> Result<(), E>

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

impl<T> PartialEq for Line<T>

where T: PartialEq + CoordNum,

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

where T: Float + RTreeNum,

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

Returns the squared distance between an object and 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 Line<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 object’s dimensionality.

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

Returns the object’s envelope.

impl<F: GeoFloat> Relate<F> for Line<F>

fn geometry_graph(&self, arg_index: usize) -> GeometryGraph<'_, F>

Returns a noded topology graph for the geometry.

fn relate(&self, other: &impl Relate<F>) -> IntersectionMatrix

where Self: Sized,

impl<T> RelativeEq for Line<T>

where T: CoordNum + RelativeEq<Epsilon = T>,

fn relative_eq( &self, other: &Line<T>, epsilon: <Line<T> as AbsDiffEq>::Epsilon, max_relative: <Line<T> as AbsDiffEq>::Epsilon, ) -> bool

Equality assertion within a relative limit.

Examples

use geo_types::{coord, Line};

let a = Line::new(coord! { x: 0., y: 0. }, coord! { x: 1., y: 1. });
let b = Line::new(coord! { x: 0., y: 0. }, coord! { x: 1.001, y: 1. });

approx::assert_relative_eq!(a, b, max_relative=0.1);

fn default_max_relative() -> <Line<T> as AbsDiffEq>::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> RemoveRepeatedPoints<T> for Line<T>

fn remove_repeated_points(&self) -> Self

Create a new geometry with (consecutive) repeated points removed.

fn remove_repeated_points_mut(&mut self)

Remove (consecutive) repeated points inplace.

impl<T> RhumbLength<T> for Line<T>

where T: CoordFloat + FromPrimitive,

fn rhumb_length(&self) -> T

👎Deprecated since 0.29.0: Please use the Rhumb.length(&line) via the Length trait instead.

Determine the length of a geometry assuming each segment is a rhumb line.

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

Performs the conversion.

impl<T> UlpsEq for Line<T>

where T: CoordNum + UlpsEq<Epsilon = T>,

fn default_max_ulps() -> u32

The default ULPs to tolerate when testing values that are far-apart.

fn ulps_eq( &self, other: &Line<T>, epsilon: <Line<T> as AbsDiffEq>::Epsilon, max_ulps: u32, ) -> bool

A test for equality that uses units in the last place (ULP) if the values are far apart.

fn ulps_ne(&self, other: &Rhs, epsilon: Self::Epsilon, max_ulps: u32) -> bool

The inverse of UlpsEq::ulps_eq.

impl<F: GeoFloat> Validation for Line<F>

type Error = InvalidLine

fn visit_validation<T>( &self, handle_validation_error: Box<dyn FnMut(Self::Error) -> Result<(), T> + '_>, ) -> Result<(), T>

Visit the validation of the geometry.

fn is_valid(&self) -> bool

Check if the geometry is valid.

fn validation_errors(&self) -> Vec<Self::Error>

Return the reason(s) of invalidity of the geometry.

fn check_validation(&self) -> Result<(), Self::Error>

Return the first reason of invalidity of the geometry.

impl<T> VincentyLength<T> for Line<T>

where T: CoordFloat + FromPrimitive,

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

The units of the returned value is meters.

impl<T> Copy for Line<T>

where T: Copy + CoordNum,

impl<T> Eq for Line<T>

where T: Eq + CoordNum,

impl<T> StructuralPartialEq for Line<T>

where T: CoordNum,