Struct LineString

pub struct LineString<T: WktNum = f64> { /* private fields */ }

A parsed LineString.

Implementations

impl<T: WktNum> LineString<T>

pub fn new(coords: Vec<Coord<T>>, dim: Dimension) -> Self

Create a new LineString from a sequence of Coord and known Dimension.

pub fn empty(dim: Dimension) -> Self

Create a new empty LineString.

pub fn from_coords(coords: impl IntoIterator<Item = Coord<T>>) -> Option<Self>

Create a new LineString from a non-empty sequence of Coord.

This will infer the dimension from the first coordinate, and will not validate that all coordinates have the same dimension.

Returns None if the input iterator is empty.

To handle empty input iterators, consider calling unwrap_or on the result and defaulting to an empty geometry with specified dimension.

pub fn dimension(&self) -> Dimension

Return the Dimension of this geometry.

pub fn coords(&self) -> &[Coord<T>]

Access the coordinates of this LineString.

pub fn into_inner(self) -> (Vec<Coord<T>>, Dimension)

Consume self and return the inner parts.

Trait Implementations

impl<T: Clone + WktNum> Clone for LineString<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug + WktNum> Debug for LineString<T>

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

Formats the value using the given formatter.

impl<T: Default + WktNum> Default for LineString<T>

fn default() -> LineString<T>

Returns the “default value” for a type.

impl<T> Display for LineString<T>

where T: WktNum + Display,

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

Formats the value using the given formatter.

impl<'a, T> From<&'a LineString<T>> for Geometry<T>

where T: CoordNum,

Available on crate feature geo-types only.

fn from(line_string: &'a LineString<T>) -> Self

Converts to this type from the input type.

impl<T> From<LineString<T>> for LineString<T>

where T: CoordNum,

Available on crate feature geo-types only.

fn from(line_string: LineString<T>) -> Self

Convert from a WKT LINESTRING to a geo_types::LineString

impl<T> From<LineString<T>> for Wkt<T>

where T: WktNum,

fn from(value: LineString<T>) -> Self

Converts to this type from the input type.

impl<'a, T: WktNum + 'a> GeometryTrait for &'a LineString<T>

type T = T

The coordinate type of this geometry

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

The type of each underlying Point, which implements PointTrait

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

The type of each underlying LineString, which implements LineStringTrait

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

The type of each underlying Polygon, which implements PolygonTrait

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

The type of each underlying MultiPoint, which implements MultiPointTrait

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

The type of each underlying MultiLineString, which implements MultiLineStringTrait

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

The type of each underlying MultiPolygon, which implements MultiPolygonTrait

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

The type of each underlying GeometryCollection, which implements GeometryCollectionTrait

type RectType<'b> = UnimplementedRect<T> where Self: 'b

The type of each underlying Rect, which implements RectTrait

type LineType<'b> = UnimplementedLine<T> where Self: 'b

The type of each underlying Line, which implements LineTrait

type TriangleType<'b> = UnimplementedTriangle<T> where Self: 'b

The type of each underlying Triangle, which implements TriangleTrait

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>, Self::RectType<'_>, Self::TriangleType<'_>, Self::LineType<'_>>

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

impl<T: WktNum> GeometryTrait for LineString<T>

type T = T

The coordinate type of this geometry

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

The type of each underlying Point, which implements PointTrait

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

The type of each underlying LineString, which implements LineStringTrait

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

The type of each underlying Polygon, which implements PolygonTrait

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

The type of each underlying MultiPoint, which implements MultiPointTrait

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

The type of each underlying MultiLineString, which implements MultiLineStringTrait

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

The type of each underlying MultiPolygon, which implements MultiPolygonTrait

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

The type of each underlying GeometryCollection, which implements GeometryCollectionTrait

type RectType<'b> = UnimplementedRect<T> where Self: 'b

The type of each underlying Rect, which implements RectTrait

type LineType<'b> = UnimplementedLine<T> where Self: 'b

The type of each underlying Line, which implements LineTrait

type TriangleType<'b> = UnimplementedTriangle<T> where Self: 'b

The type of each underlying Triangle, which implements TriangleTrait

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>, Self::RectType<'_>, Self::TriangleType<'_>, Self::LineType<'_>>

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

impl<'a, T: WktNum> LineStringTrait for &'a LineString<T>

type CoordType<'b> = &'a Coord<T> where Self: 'b

The type of each underlying coordinate, which implements CoordTrait

fn num_coords(&self) -> usize

The number of coordinates in this LineString

unsafe fn coord_unchecked(&self, i: usize) -> Self::CoordType<'_>

Access to a specified coordinate in this LineString

fn coords(&self) -> impl DoubleEndedIterator + ExactSizeIterator

An iterator over the coordinates in this LineString

fn coord(&self, i: usize) -> Option<Self::CoordType<'_>>

Access to a specified coordinate in this LineString Will return None if the provided index is out of bounds

impl<T: WktNum> LineStringTrait for LineString<T>

type CoordType<'a> = &'a Coord<T> where Self: 'a

The type of each underlying coordinate, which implements CoordTrait

fn num_coords(&self) -> usize

The number of coordinates in this LineString

unsafe fn coord_unchecked(&self, i: usize) -> Self::CoordType<'_>

Access to a specified coordinate in this LineString

fn coords(&self) -> impl DoubleEndedIterator + ExactSizeIterator

An iterator over the coordinates in this LineString

fn coord(&self, i: usize) -> Option<Self::CoordType<'_>>

Access to a specified coordinate in this LineString Will return None if the provided index is out of bounds

impl<T: PartialEq + WktNum> PartialEq for LineString<T>

fn eq(&self, other: &LineString<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: WktNum> StructuralPartialEq for LineString<T>