Struct geo::Line

pub struct Line<T> where
    T: CoordNum,  {
    pub start: Coordinate<T>,
    pub end: Coordinate<T>,
}

A line segment made up of exactly two Coordinates.

Semantics

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

Fields

start: Coordinate<T>

end: Coordinate<T>

Implementations

impl<T> Line<T> where
    T: CoordNum, 

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

Creates a new line segment.

Examples

use geo_types::{Coordinate, Line};

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

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

pub fn delta(&self) -> Coordinate<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<Line<T>> for Line<T> where
    T: AbsDiffEq<T, Epsilon = T> + CoordNum, 

type Epsilon = T

Used for specifying relative comparisons.

pub fn default_epsilon() -> <Line<T> as AbsDiffEq<Line<T>>>::Epsilon

The default tolerance to use when testing values that are close together.

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

Equality assertion with an absolute limit.

Examples

use geo_types::{Coordinate, Line};

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

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

pub 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, 

type Output = Point<T>

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

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

impl<T> Clone for Line<T> where
    T: Clone + CoordNum, 

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Find the closest point between self and p.

impl<T> Contains<Coordinate<T>> for Line<T> where
    T: GeoNum, 

fn contains(&self, coord: &Coordinate<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 Line<T> where
    T: GeoNum, 

fn contains(&self, line: &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 Polygon<T> where
    T: GeoFloat, 

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

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

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

impl<T> Contains<Point<T>> for Line<T> where
    T: GeoNum, 

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

impl<T> CoordinatePosition for Line<T> where
    T: GeoNum, 

type Scalar = T

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

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

impl<'a, T: CoordNum> CoordsIter<'a> for Line<T>

type Iter = Chain<Once<Coordinate<T>>, Once<Coordinate<T>>>

type ExteriorIter = Self::Iter

type Scalar = T

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

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

fn coords_count(&'a self) -> usize

Return the number of coordinates in the Line.

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

Iterate over all exterior coordinates of a geometry.

impl<T> Copy for Line<T> where
    T: Copy + CoordNum, 

impl<T> Debug for Line<T> where
    T: Debug + CoordNum, 

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

Formats the value using the given formatter.

impl<T> Eq for Line<T> where
    T: Eq + CoordNum, 

impl<T> EuclideanDistance<T, Coordinate<T>> for Line<T> where
    T: GeoFloat, 

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

Minimum distance from a Line to a Coordinate

impl<T> EuclideanDistance<T, Line<T>> for Coordinate<T> where
    T: GeoFloat, 

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

Minimum distance from a Coordinate to a Line

impl<T> EuclideanDistance<T, Line<T>> for Point<T> where
    T: GeoFloat, 

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

Minimum distance from a Line to a Point

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

Line to Line distance

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

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

Returns the distance between two geometries

impl<T> EuclideanDistance<T, Line<T>> for Polygon<T> where
    T: GeoFloat + FloatConst + Signed + RTreeNum, 

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

Returns the distance between two geometries

impl<T> EuclideanDistance<T, Line<T>> for MultiPolygon<T> where
    T: GeoFloat + FloatConst + Signed + RTreeNum, 

MultiPolygon to Line distance

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

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

Returns the distance between two geometries

impl<T> EuclideanDistance<T, MultiPolygon<T>> for Line<T> where
    T: GeoFloat + FloatConst + Signed + RTreeNum, 

Line to MultiPolygon distance

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

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

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

Returns the distance between two geometries

impl<T> EuclideanLength<T, Line<T>> for Line<T> where
    T: CoordFloat, 

fn euclidean_length(&self) -> T

Calculation of the length of a Line

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

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

Performs the conversion.

impl<T> From<Line<T>> for Geometry<T> where
    T: CoordNum, 

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

Performs the conversion.

impl<T> From<Line<T>> for LineString<T> where
    T: CoordNum, 

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

Performs the conversion.

impl GeodesicLength<f64, Line<f64>> for Line<f64>

fn geodesic_length(&self) -> f64

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, 

pub fn hash<__H>(&self, state: &mut __H) where
    __H: Hasher, 

Feeds this value into the given Hasher.

pub 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, Line<T>> for Line<T> where
    T: CoordFloat + FromPrimitive, 

fn haversine_length(&self) -> T

Determine the length of a geometry using the haversine formula.

impl<T> Intersects<Coordinate<T>> for Line<T> where
    T: GeoNum, 

fn intersects(&self, rhs: &Coordinate<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 Coordinate<T> where
    Line<T>: Intersects<Coordinate<T>>,
    T: CoordNum, 

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

impl<T> Intersects<Line<T>> for Line<T> where
    T: GeoNum, 

fn intersects(&self, line: &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<LineString<T>> for Line<T> where
    LineString<T>: Intersects<Line<T>>,
    T: CoordNum, 

fn intersects(&self, rhs: &LineString<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
    Triangle<T>: Intersects<Line<T>>,
    T: CoordNum, 

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

impl<T> LineInterpolatePoint<T> for Line<T> where
    T: CoordFloat, 

type Output = Option<Point<T>>

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

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<T: CoordNum, NT: CoordNum> MapCoords<T, NT> for Line<T>

type Output = Line<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: CoordNum> MapCoordsInplace<T> for Line<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<Line<T>> for Line<T> where
    T: PartialEq<T> + CoordNum, 

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

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

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

This method tests for !=.

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

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

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

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

Returns true if a point is contained within this object.

pub 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 objects dimensionality.

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

Returns the object’s envelope.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

impl<T> RelativeEq<Line<T>> for Line<T> where
    T: AbsDiffEq<T, Epsilon = T> + CoordNum + RelativeEq<T>, 

pub fn default_max_relative() -> <Line<T> as AbsDiffEq<Line<T>>>::Epsilon

The default relative tolerance for testing values that are far-apart.

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

Equality assertion within a relative limit.

Examples

use geo_types::{Coordinate, Line};

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

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

pub fn relative_ne(
    &self,
    other: &Rhs,
    epsilon: Self::Epsilon,
    max_relative: Self::Epsilon
) -> bool

The inverse of [RelativeEq::relative_eq].

impl<T> Rotate<T> for Line<T> where
    T: GeoFloat, 

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

Rotate a Geometry around its centroid by an angle, in degrees

impl<T> StructuralEq for Line<T> where
    T: CoordNum, 

impl<T> StructuralPartialEq for Line<T> where
    T: CoordNum, 

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.

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

Performs the conversion.

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

type Output = Line<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, Line<T>> for Line<T> where
    T: CoordFloat + FromPrimitive, 

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

The units of the returned value is meters.