Struct geo::geometry::Line

source · [−]

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

Expand description

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

source

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

source

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

Creates a new line segment.

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

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

source

pub fn dx(&self) -> T

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

Equivalent to:

line.end.x - line.start.x

source

pub fn dy(&self) -> T

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

Equivalent to:

line.end.y - line.start.y

source

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()

source

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()

source

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

source

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

source

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

Trait Implementations

source

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

source

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::{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.

source

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

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

fn abs_diff_ne(&self, other: &Rhs, epsilon: Self::Epsilon) -> bool

The inverse of [AbsDiffEq::abs_diff_eq].

source

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

type Output = Rect<T>

source

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

Return the bounding rectangle of a geometry Read more

source

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

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

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

source

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

source

fn chamberlain_duquette_signed_area(&self) -> T

source

fn chamberlain_duquette_unsigned_area(&self) -> T

source

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

source

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

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

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

source

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

Find the closest point between self and p.

source

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

source

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

source

impl<T> Contains<Geometry<T>> for Line<T> where
T: GeoFloat,

source

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

source

impl<T> Contains<GeometryCollection<T>> for Line<T> where
T: GeoFloat,

source

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

source

impl<F> Contains<Line<F>> for MultiPolygon<F> where
F: GeoFloat,

source

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

source

impl<T> Contains<Line<T>> for Geometry<T> where
T: GeoFloat,

source

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

source

impl<T> Contains<Line<T>> for GeometryCollection<T> where
T: GeoFloat,

source

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

source

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

source

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

source

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

source

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

source

impl<T> Contains<Line<T>> for MultiLineString<T> where
T: GeoFloat,

source

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

source

impl<T> Contains<Line<T>> for MultiPoint<T> where
T: GeoFloat,

source

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

source

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

source

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

source

impl<T> Contains<Line<T>> for Polygon<T> where
T: GeoFloat,

source

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

source

impl<T> Contains<Line<T>> for Rect<T> where
T: GeoFloat,

source

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

source

impl<T> Contains<Line<T>> for Triangle<T> where
T: GeoFloat,

source

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

source

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

source

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

source

impl<T> Contains<MultiLineString<T>> for Line<T> where
T: GeoFloat,

source

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

source

impl<T> Contains<MultiPoint<T>> for Line<T> where
T: GeoFloat,

source

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

source

impl<T> Contains<MultiPolygon<T>> for Line<T> where
T: GeoFloat,

source

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

source

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

source

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

source

impl<T> Contains<Polygon<T>> for Line<T> where
T: GeoFloat,

source

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

source

impl<T> Contains<Rect<T>> for Line<T> where
T: GeoFloat,

source

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

source

impl<T> Contains<Triangle<T>> for Line<T> where
T: GeoFloat,

source

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

source

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

type Scalar = T

source

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

source

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

source

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

source

fn coords_count(&'a self) -> usize

Return the number of coordinates in the Line.

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

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

type Scalar = T

source

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

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

source

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

Iterate over all exterior coordinates of a geometry. Read more

source

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

type Scalar = T

Scalar used the coordinates.

source

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. Read more

source

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

source

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

Formats the value using the given formatter. Read more

source

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

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

source

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

source

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

Minimum distance from a Line to a Coordinate

source

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

source

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

Minimum distance from a Coordinate to a Line

source

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

Line to Line distance

source

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

Returns the distance between two geometries Read more

source

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

LineString to Line

source

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

Returns the distance between two geometries Read more

source

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

MultiPolygon to Line distance

source

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

Returns the distance between two geometries Read more

source

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

source

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

Minimum distance from a Line to a Point

source

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

source

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

Returns the distance between two geometries Read more

source

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

Line to LineString

source

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

Returns the distance between two geometries Read more

source

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

Line to MultiPolygon distance

source

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

Returns the distance between two geometries Read more

source

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

source

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

Minimum distance from a Line to a Point

source

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

source

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

Returns the distance between two geometries Read more

source

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

source

fn euclidean_length(&self) -> T

Calculation of the length of a Line Read more

source

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

source

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

Converts to this type from the input type.

source

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

source

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

Converts to this type from the input type.

source

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

Convert from a Line ensuring end point ordering.

source

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

Converts to this type from the input type.

source

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

source

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

Converts to this type from the input type.

source

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

source

fn geodesic_length(&self) -> f64

The units of the returned value is meters.

source

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

source

fn is_empty(&self) -> bool

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

source

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. Read more

source

fn boundary_dimensions(&self) -> Dimensions

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

source

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

source

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

Feeds this value into the given Hasher. Read more

1.3.0 · source

fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,

Feeds a slice of this type into the given Hasher. Read more

source

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

source

fn haversine_length(&self) -> T

Determine the length of a geometry using the haversine formula. Read more

source

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

type Output = Point<T>

source

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

Calculates a representative point inside the Geometry Read more

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

type Output = Option<Point<T>>

source

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

source

impl<T> LineLocatePoint<T, Point<T>> for Line<T> where
T: CoordFloat,

type Output = Option<T>

type Rhs = Point<T>

source

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

source

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

source

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

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

source

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

type Output = Line<NT>

source

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

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

source

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

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

source

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

source

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

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

source

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

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

source

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

source

fn map_coords_inplace(&mut self, func: impl Fn((T, T)) -> (T, T) + Copy) where
T: CoordNum,

👎Deprecated since 0.21.0:

use MapCoordsInPlace::map_coords_in_place instead which takes a Coordinate instead of an (x,y) tuple

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

Examples

#[allow(deprecated)]
use geo::MapCoordsInplace;
use geo::Point;
use approx::assert_relative_eq;

let mut p = Point::new(10., 20.);
#[allow(deprecated)]
p.map_coords_inplace(|(x, y)| (x + 1000., y * 2.));

assert_relative_eq!(p, Point::new(1010., 40.), epsilon = 1e-6);

source

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

source

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

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

1.0.0 · source

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason. Read more

source

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

source

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

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

source

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

Returns true if a point is contained within this object. Read more

source

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. Read more

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 object’s dimensionality. Read more

source

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

Returns the object’s envelope. Read more

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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::{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);

source

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

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

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

The inverse of [RelativeEq::relative_eq].

source

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.

source

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

Performs the conversion.

source

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

type Output = Line<NT>

👎Deprecated since 0.21.0:

use MapCoords::try_map_coords which takes a Coordinate instead of an (x,y) tuple

source

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

👎Deprecated since 0.21.0:

use MapCoords::try_map_coords which takes a Coordinate instead of an (x,y) tuple

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

source

impl<T: CoordNum, E> TryMapCoordsInplace<T, E> for Line<T>

source

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

👎Deprecated since 0.21.0:

use MapCoordsInPlace::try_map_coords_in_place which takes a Coordinate instead of an (x,y) tuple

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

source

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

source

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

The units of the returned value is meters.

source

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

source

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

source

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

source

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

Auto Trait Implementations

impl<T> RefUnwindSafe for Line<T> where
T: RefUnwindSafe,

impl<T> Send for Line<T> where
T: Send,

impl<T> Sync for Line<T> where
T: Sync,

impl<T> Unpin for Line<T> where
T: Unpin,

impl<T> UnwindSafe for Line<T> where
T: UnwindSafe,

Blanket Implementations

source

impl<T, M> AffineOps<T> for M where
T: CoordNum,
M: MapCoordsInPlace<T> + MapCoords<T, T, Output = M>,

source

fn affine_transform(&self, transform: &AffineTransform<T>) -> M

Apply transform immutably, outputting a new geometry.

source

fn affine_transform_mut(&mut self, transform: &AffineTransform<T>)

Apply transform to mutate self.

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<G, T, U> Convert<T, U> for G where
 T: CoordNum,
 U: CoordNum + From<T>,
 G: MapCoords<T, U>,

type Output = <G as MapCoords<T, U>>::Output

source

fn convert(&self) -> <G as Convert<T, U>>::Output

source

impl<'a, T, G> ConvexHull<'a, T> for G where
T: GeoNum,
G: CoordsIter<'a, Scalar = T>,

type Scalar = T

source

fn convex_hull(&'a self) -> Polygon<T>

source

impl<'a, T, G> Extremes<'a, T> for G where
G: CoordsIter<'a, Scalar = T>,
T: CoordNum,

source

fn extremes(&'a self) -> Option<Outcome<T>>

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<G, IP, IR, T> Rotate<T> for G where
 T: CoordFloat,
 IP: Into<Option<Point<T>>>,
 IR: Into<Option<Rect<T>>>,
 G: Clone + Centroid<Output = IP> + BoundingRect<T, Output = IR> + AffineOps<T>,

source

fn rotate_around_centroid(&self, degrees: T) -> G

Rotate a geometry around its centroid by an angle, in degrees Read more

source

fn rotate_around_centroid_mut(&mut self, degrees: T)

Mutable version of Self::rotate_around_centroid

source

fn rotate_around_center(&self, degrees: T) -> G

Rotate a geometry around the center of its bounding box by an angle, in degrees. Read more

source

fn rotate_around_center_mut(&mut self, degrees: T)

Mutable version of Self::rotate_around_center

source

fn rotate_around_point(&self, degrees: T, point: Point<T>) -> G

Rotate a Geometry around an arbitrary point by an angle, given in degrees Read more

source

fn rotate_around_point_mut(&mut self, degrees: T, point: Point<T>)

Mutable version of Self::rotate_around_point

source

impl<T, IR, G> Scale<T> for G where
 T: CoordFloat,
 IR: Into<Option<Rect<T>>>,
 G: Clone + AffineOps<T> + BoundingRect<T, Output = IR>,

source

fn scale(&self, scale_factor: T) -> G

Scale a geometry from it’s bounding box center. Read more

source

fn scale_mut(&mut self, scale_factor: T)

Mutable version of scale

source

fn scale_xy(&self, x_factor: T, y_factor: T) -> G

Scale a geometry from it’s bounding box center, using different values for x_factor and y_factor to distort the geometry’s aspect ratio. Read more

source

fn scale_xy_mut(&mut self, x_factor: T, y_factor: T)

Mutable version of scale_xy.

source

fn scale_around_point(
 &self,
 x_factor: T,
 y_factor: T,
 origin: impl Into<Coordinate<T>>
) -> G

Scale a geometry around a point of origin. Read more

source

fn scale_around_point_mut(
 &mut self,
 x_factor: T,
 y_factor: T,
 origin: impl Into<Coordinate<T>>
)

Mutable version of scale_around_point.

source

impl<T, IR, G> Skew<T> for G where
 T: CoordFloat,
 IR: Into<Option<Rect<T>>>,
 G: Clone + AffineOps<T> + BoundingRect<T, Output = IR>,

source

fn skew(&self, degrees: T) -> G

An affine transformation which skews a geometry, sheared by a uniform angle along the x and y dimensions. Read more

source

fn skew_mut(&mut self, degrees: T)

Mutable version of skew.

source

fn skew_xy(&self, degrees_x: T, degrees_y: T) -> G

An affine transformation which skews a geometry, sheared by an angle along the x and y dimensions. Read more

source

fn skew_xy_mut(&mut self, degrees_x: T, degrees_y: T)

Mutable version of skew_xy.

source

fn skew_around_point(&self, xs: T, ys: T, origin: impl Into<Coordinate<T>>) -> G

An affine transformation which skews a geometry around a point of origin, sheared by an angle along the x and y dimensions. Read more

source

fn skew_around_point_mut(&mut self, xs: T, ys: T, origin: impl Into<Coordinate<T>>)

Mutable version of skew_around_point.

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, G> Translate<T> for G where
T: CoordNum,
G: AffineOps<T>,

source

fn translate(&self, x_offset: T, y_offset: T) -> G

Translate a Geometry along its axes by the given offsets Read more

source

fn translate_mut(&mut self, x_offset: T, y_offset: T)

Translate a Geometry along its axes, but in place.

source

fn translate_in_place(&mut self, x_offset: T, y_offset: T)

source

fn translate_inplace(&mut self, x_offset: T, y_offset: T)

source

impl<G, T, U> TryConvert<T, U> for G where
 T: CoordNum,
 U: CoordNum + TryFrom<T>,
 G: MapCoords<T, U>,

type Output = Result<<G as MapCoords<T, U>>::Output, >::Error>

source

fn try_convert(&self) -> <G as TryConvert<T, U>>::Output

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

source

impl<G1, G2> Within<G2> for G1 where
G2: Contains<G1>,

source

Struct geo::geometry::Line

Fields

Implementations

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

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

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

pub fn dx(&self) -> T

pub fn dy(&self) -> T

pub fn slope(&self) -> T

pub fn determinant(&self) -> T

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,

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

type Epsilon = T

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

fn abs_diff_ne(&self, other: &Rhs, epsilon: Self::Epsilon) -> bool

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

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

type Output = Point<T>

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

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>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

impl<T> Contains<Geometry<T>> for Line<T> where
T: GeoFloat,

impl<T> Contains<GeometryCollection<T>> for Line<T> where
T: GeoFloat,

impl<F> Contains<Line<F>> for MultiPolygon<F> where
F: GeoFloat,

impl<T> Contains<Line<T>> for Geometry<T> where
T: GeoFloat,

impl<T> Contains<Line<T>> for GeometryCollection<T> where
T: GeoFloat,

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

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

impl<T> Contains<Line<T>> for MultiLineString<T> where
T: GeoFloat,

impl<T> Contains<Line<T>> for MultiPoint<T> where
T: GeoFloat,

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

impl<T> Contains<Line<T>> for Polygon<T> where
T: GeoFloat,

impl<T> Contains<Line<T>> for Rect<T> where
T: GeoFloat,

impl<T> Contains<Line<T>> for Triangle<T> where
T: GeoFloat,

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

impl<T> Contains<MultiLineString<T>> for Line<T> where
T: GeoFloat,

impl<T> Contains<MultiPoint<T>> for Line<T> where
T: GeoFloat,

impl<T> Contains<MultiPolygon<T>> for Line<T> where
T: GeoFloat,

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

impl<T> Contains<Polygon<T>> for Line<T> where
T: GeoFloat,

impl<T> Contains<Rect<T>> for Line<T> where
T: GeoFloat,

impl<T> Contains<Triangle<T>> for Line<T> where
T: GeoFloat,

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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