Struct geo::Line

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

A line segment made up of exactly two Points.

Fields

start: Coordinate<T>

end: Coordinate<T>

Methods

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

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 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> Copy for Line<T> where
    T: Copy + CoordinateType, 

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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.

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

Returns the object's envelope.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Formats the value using the given formatter.

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

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

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

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

This method tests for !=.

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

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

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

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

Returns true if a point is contained within this object.

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

fn area(&self) -> T

Signed area of a geometry.

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

type Output = Rect<T>

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

Return the bounding rectangle of a geometry

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

type Output = Point<T>

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

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

impl<F: Float> 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<Point<T>> for Line<T> where
    T: Float, 

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

Checks if rhs is completely contained within self.

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

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

Checks if rhs is completely contained within self.

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

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

Minimum distance from a Line to a Point

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

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

Minimum distance from a Line to a Point

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

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

Returns the distance between two geometries

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

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

Returns the distance between two geometries

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

fn euclidean_length(&self) -> T

Calculation of the length of a Line

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

fn haversine_length(&self) -> T

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

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

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

Checks if the geometry A intersects the geometry B.

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

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

Checks if the geometry A intersects the geometry B.

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

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

Checks if the geometry A intersects the geometry B.

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

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

Checks if the geometry A intersects the geometry B.

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

type Output = Line<NT>

fn map_coords(&self, func: &dyn 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 Line<T>

type Output = Line<NT>

fn try_map_coords(
    &self,
    func: &dyn 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 Line<T>

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

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

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

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

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

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

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

The units of the returned value is meters.