Struct LineString 

pub struct LineString {
    pub srid: SRID,
    pub geom: LineString<f64>,
}

A linearly interpolated path between locations.

MySQL extension: The spatial reference system identifier (SRID) may identify the used coordinate system.

Fields

srid: SRID

geom: LineString<f64>

Methods from Deref<Target = LineString<f64>>

pub fn points_iter(&self) -> PointsIter<'_, T>

👎Deprecated: Use points() instead

Return an iterator yielding the coordinates of a LineString as Points

pub fn points(&self) -> PointsIter<'_, T>

Return an iterator yielding the coordinates of a LineString as Points

pub fn coords(&self) -> impl DoubleEndedIterator

Return an iterator yielding the members of a LineString as Coords

pub fn coords_mut(&mut self) -> impl DoubleEndedIterator

Return an iterator yielding the coordinates of a LineString as mutable Coords

pub fn lines(&self) -> impl ExactSizeIterator

Return an iterator yielding one Line for each line segment in the LineString.

Examples

use geo_types::{wkt, Line, LineString};

let line_string = wkt!(LINESTRING(0 0,5 0,7 9));
let mut lines = line_string.lines();

assert_eq!(
    Some(Line::new((0, 0), (5, 0))),
    lines.next()
);
assert_eq!(
    Some(Line::new((5, 0), (7, 9))),
    lines.next()
);
assert!(lines.next().is_none());

pub fn rev_lines(&self) -> impl ExactSizeIterator

Return an iterator yielding one Line for each line segment in the LineString, starting from the end point of the LineString, working towards the start.

Note: This is like Self::lines, but the sequence and the orientation of segments are reversed.

Examples

use geo_types::{wkt, Line, LineString};

let line_string = wkt!(LINESTRING(0 0,5 0,7 9));
let mut lines = line_string.rev_lines();

assert_eq!(
    Some(Line::new((7, 9), (5, 0))),
    lines.next()
);
assert_eq!(
    Some(Line::new((5, 0), (0, 0))),
    lines.next()
);
assert!(lines.next().is_none());

pub fn triangles(&self) -> impl ExactSizeIterator

An iterator which yields the coordinates of a LineString as Triangles

pub fn close(&mut self)

Close the LineString. Specifically, if the LineString has at least one Coord, and the value of the first Coord does not equal the value of the last Coord, then a new Coord is added to the end with the value of the first Coord.

pub fn num_coords(&self) -> usize

👎Deprecated: Use geo::CoordsIter::coords_count instead

Return the number of coordinates in the LineString.

Examples

use geo_types::LineString;

let mut coords = vec![(0., 0.), (5., 0.), (7., 9.)];
let line_string: LineString<f32> = coords.into_iter().collect();

assert_eq!(3, line_string.num_coords());

pub fn is_closed(&self) -> bool

Checks if the linestring is closed; i.e. it is either empty or, the first and last points are the same.

Examples

use geo_types::LineString;

let mut coords = vec![(0., 0.), (5., 0.), (0., 0.)];
let line_string: LineString<f32> = coords.into_iter().collect();
assert!(line_string.is_closed());

Note that we diverge from some libraries (JTS et al), which have a LinearRing type, separate from LineString. Those libraries treat an empty LinearRing as closed by definition, while treating an empty LineString as open. Since we don’t have a separate LinearRing type, and use a LineString in its place, we adopt the JTS LinearRing is_closed behavior in all places: that is, we consider an empty LineString as closed.

This is expected when used in the context of a Polygon.exterior and elsewhere; And there seems to be no reason to maintain the separate behavior for LineStrings used in non-LinearRing contexts.

Trait Implementations

impl AsMut<LineString> for LineString

fn as_mut(&mut self) -> &mut LineString<f64>

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<LineString> for LineString

fn as_ref(&self) -> &LineString<f64>

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for LineString

fn clone(&self) -> LineString

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LineString

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

Formats the value using the given formatter.

impl Deref for LineString

type Target = LineString

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for LineString

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl From<LineString> for Geometry

fn from(other: LineString) -> Self

Converts to this type from the input type.

impl From<LineString> for LineString

fn from(geom: LineString<f64>) -> Self

Converts to this type from the input type.

impl FromSql<LineString, Mysql> for LineString

fn from_sql(bytes: Option<&[u8]>) -> Result<Self>

See the trait documentation.

impl<__ST, __DB> FromSqlRow<__ST, __DB> for LineString

where __DB: Backend, Self: FromSql<__ST, __DB>,

fn build_from_row<R: Row<__DB>>(row: &mut R) -> Result<Self>

See the trait documentation.

const FIELDS_NEEDED: usize = 1usize

The number of fields that this type will consume. Must be equal to the number of times you would call row.take() in build_from_row

impl PartialEq for LineString

fn eq(&self, other: &LineString) -> 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<__ST, __DB> Queryable<__ST, __DB> for LineString

where __DB: Backend, Self: FromSql<__ST, __DB>,

type Row = LineString

The Rust type you’d like to map from.

fn build(row: Self::Row) -> Self

Construct an instance of this type

impl ToSql<Geometry, Mysql> for LineString

fn to_sql<W: Write>(&self, out: &mut Output<'_, W, Mysql>) -> Result

See the trait documentation.

impl ToSql<LineString, Mysql> for LineString

fn to_sql<W: Write>(&self, out: &mut Output<'_, W, Mysql>) -> Result

See the trait documentation.

impl TryFrom<Geometry> for LineString

type Error = <LineString as TryFrom<Geometry>>::Error

The type returned in the event of a conversion error.

fn try_from(other: Geometry) -> Result<Self, Self::Error>

Performs the conversion.

impl StructuralPartialEq for LineString