Struct Line 

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

Available on crate feature geo-types only.

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> Clone for Line<T>

where T: Clone + CoordNum,

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

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<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<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> 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<'a, T> GeometryTrait for &'a Line<T>

where T: CoordNum + 'a,

type T = T

The coordinate type of this geometry

type PointType<'b> = Point<<&'a Line<T> as GeometryTrait>::T> where &'a Line<T>: 'b

The type of each underlying Point, which implements PointTrait

type LineStringType<'b> = LineString<<&'a Line<T> as GeometryTrait>::T> where &'a Line<T>: 'b

The type of each underlying LineString, which implements LineStringTrait

type PolygonType<'b> = Polygon<<&'a Line<T> as GeometryTrait>::T> where &'a Line<T>: 'b

The type of each underlying Polygon, which implements PolygonTrait

type MultiPointType<'b> = MultiPoint<<&'a Line<T> as GeometryTrait>::T> where &'a Line<T>: 'b

The type of each underlying MultiPoint, which implements MultiPointTrait

type MultiLineStringType<'b> = MultiLineString<<&'a Line<T> as GeometryTrait>::T> where &'a Line<T>: 'b

The type of each underlying MultiLineString, which implements MultiLineStringTrait

type MultiPolygonType<'b> = MultiPolygon<<&'a Line<T> as GeometryTrait>::T> where &'a Line<T>: 'b

The type of each underlying MultiPolygon, which implements MultiPolygonTrait

type GeometryCollectionType<'b> = GeometryCollection<<&'a Line<T> as GeometryTrait>::T> where &'a Line<T>: 'b

The type of each underlying GeometryCollection, which implements GeometryCollectionTrait

type RectType<'b> = Rect<<&'a Line<T> as GeometryTrait>::T> where &'a Line<T>: 'b

The type of each underlying Rect, which implements RectTrait

type TriangleType<'b> = Triangle<<&'a Line<T> as GeometryTrait>::T> where &'a Line<T>: 'b

The type of each underlying Triangle, which implements TriangleTrait

type LineType<'b> = Line<<&'a Line<T> as GeometryTrait>::T> where &'a Line<T>: 'b

The type of each underlying Line, which implements LineTrait

fn dim(&self) -> Dimensions

The dimension of this geometry

fn as_type( &self, ) -> GeometryType<'_, Point<T>, LineString<T>, Polygon<T>, MultiPoint<T>, MultiLineString<T>, MultiPolygon<T>, GeometryCollection<T>, Rect<T>, Triangle<T>, Line<T>>

Cast this geometry to a GeometryType enum, which allows for downcasting to a specific type

impl<T> GeometryTrait for Line<T>

where T: CoordNum,

type T = T

The coordinate type of this geometry

type PointType<'b> = Point<<Line<T> as GeometryTrait>::T> where Line<T>: 'b

The type of each underlying Point, which implements PointTrait

type LineStringType<'b> = LineString<<Line<T> as GeometryTrait>::T> where Line<T>: 'b

The type of each underlying LineString, which implements LineStringTrait

type PolygonType<'b> = Polygon<<Line<T> as GeometryTrait>::T> where Line<T>: 'b

The type of each underlying Polygon, which implements PolygonTrait

type MultiPointType<'b> = MultiPoint<<Line<T> as GeometryTrait>::T> where Line<T>: 'b

The type of each underlying MultiPoint, which implements MultiPointTrait

type MultiLineStringType<'b> = MultiLineString<<Line<T> as GeometryTrait>::T> where Line<T>: 'b

The type of each underlying MultiLineString, which implements MultiLineStringTrait

type MultiPolygonType<'b> = MultiPolygon<<Line<T> as GeometryTrait>::T> where Line<T>: 'b

The type of each underlying MultiPolygon, which implements MultiPolygonTrait

type GeometryCollectionType<'b> = GeometryCollection<<Line<T> as GeometryTrait>::T> where Line<T>: 'b

The type of each underlying GeometryCollection, which implements GeometryCollectionTrait

type RectType<'b> = Rect<<Line<T> as GeometryTrait>::T> where Line<T>: 'b

The type of each underlying Rect, which implements RectTrait

type TriangleType<'b> = Triangle<<Line<T> as GeometryTrait>::T> where Line<T>: 'b

The type of each underlying Triangle, which implements TriangleTrait

type LineType<'b> = Line<<Line<T> as GeometryTrait>::T> where Line<T>: 'b

The type of each underlying Line, which implements LineTrait

fn dim(&self) -> Dimensions

The dimension of this geometry

fn as_type( &self, ) -> GeometryType<'_, Point<T>, LineString<T>, Polygon<T>, MultiPoint<T>, MultiLineString<T>, MultiPolygon<T>, GeometryCollection<T>, Rect<T>, Triangle<T>, Line<T>>

Cast this geometry to a GeometryType enum, which allows for downcasting to a specific type

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<'a, T> LineTrait for &'a Line<T>

where T: CoordNum,

type CoordType<'b> = &'a Coord<<&'a Line<T> as GeometryTrait>::T> where &'a Line<T>: 'b

The type of each underlying coordinate, which implements CoordTrait

fn start(&self) -> <&'a Line<T> as LineTrait>::CoordType<'_>

Access the start coordinate in this Line

fn end(&self) -> <&'a Line<T> as LineTrait>::CoordType<'_>

Access the start coordinate in this Line

fn coords(&self) -> [Self::CoordType<'_>; 2]

Access the two underlying coordinates

impl<T> LineTrait for Line<T>

where T: CoordNum,

type CoordType<'a> = &'a Coord<<Line<T> as GeometryTrait>::T> where Line<T>: 'a

The type of each underlying coordinate, which implements CoordTrait

fn start(&self) -> <Line<T> as LineTrait>::CoordType<'_>

Access the start coordinate in this Line

fn end(&self) -> <Line<T> as LineTrait>::CoordType<'_>

Access the start coordinate in this Line

fn coords(&self) -> [Self::CoordType<'_>; 2]

Access the two underlying coordinates

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> ToWkt<T> for Line<T>

where T: CoordNum + Display,

Examples

use geo_types::{coord, Line};
use wkt::ToWkt;

let line = Line::<f64>::new(coord!(x: 1., y: 2.), coord!(x: 3., y: 4.));

assert_eq!(line.wkt_string(), "LINESTRING(1 2,3 4)");

fn to_wkt(&self) -> Wkt<T>

Converts the value of self to an Wkt struct.

fn write_wkt(&self, writer: impl Write) -> Result<(), Error>

Write a WKT string to a File, or anything else that implements Write.

fn wkt_string(&self) -> String

Serialize as a WKT string

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> TryFrom<Wkt<T>> for Line<T>

where T: CoordNum,

Fallibly convert this WKT primitive into this geo_types primitive

type Error = Error

The type returned in the event of a conversion error.

fn try_from(wkt: Wkt<T>) -> Result<Line<T>, <Line<T> as TryFrom<Wkt<T>>>::Error>

Performs the conversion.

impl<T> TryFromWkt<T> for Line<T>

where T: CoordNum + FromStr + Default,

type Error = Error

fn try_from_wkt_str( wkt_str: &str, ) -> Result<Line<T>, <Line<T> as TryFromWkt<T>>::Error>

Examples

fn try_from_wkt_reader( wkt_reader: impl Read, ) -> Result<Line<T>, <Line<T> as TryFromWkt<T>>::Error>

Examples

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,