Struct geos::ConstGeometry

pub struct ConstGeometry<'a, 'b> { /* private fields */ }

only not mutable operations are implemented on it.

Example

use geos::{Geom, Geometry};

let geom = Geometry::new_from_wkt("POLYGON((0 0, 10 0, 10 6, 0 6, 0 0),\
                                           (1 1, 2 1, 2 5, 1 5, 1 1),\
                                           (8 5, 8 4, 9 4, 9 5, 8 5))")
                   .expect("Invalid geometry");
let point_geom = geom
    .get_interior_ring_n(0)
    .expect("failed to get const geometry");

Implementations

impl<'a, 'b> ConstGeometry<'a, 'b>

pub fn get_context_handle(&self) -> &ContextHandle<'a>

Get the context handle of the geometry.

use geos::{ContextInteractions, Geometry};

let point_geom = Geometry::new_from_wkt("POINT (2.5 2.5)").expect("Invalid geometry");
let context = point_geom.get_context_handle();
context.set_notice_message_handler(Some(Box::new(|s| println!("new message: {}", s))));

Trait Implementations

impl<'a, 'd> ContextHandling for ConstGeometry<'a, 'd>

type Context = Arc<ContextHandle<'a>>

fn clone_context(&self) -> Arc<ContextHandle<'a>>

impl<'a, 'd> Geom<'a> for ConstGeometry<'a, 'd>

fn get_type(&self) -> GResult<String>

Returns the type of the geometry.

fn geometry_type(&self) -> GeometryTypes

fn is_valid(&self) -> bool

Checks if the geometry is valid.

fn is_valid_reason(&self) -> GResult<String>

Returns an explanation on why the geometry is invalid.

fn get_coord_seq(&self) -> GResult<CoordSeq<'a>>

Get the underlying geos CoordSeq object from the geometry

fn area(&self) -> GResult<f64>

Returns the area of the geometry. Units are specified by the SRID of the given geometry.

fn to_wkt(&self) -> GResult<String>

Returns a WKT representation of the geometry. It defaults to 2 dimensions output. Use WKTWriter type directly if you want more control.

fn to_wkt_precision(&self, precision: u32) -> GResult<String>

Returns a WKT representation of the geometry with the given precision. It is a wrapper around WKTWriter::set_rounding_precision.

fn is_ring(&self) -> GResult<bool>

Returns true if the geometry is a ring.

fn intersects<'b, G: Geom<'b>>(&self, other: &G) -> GResult<bool>

Returns true if self shares any portion of space with other. So if any of this is true:

fn crosses<'b, G: Geom<'b>>(&self, other: &G) -> GResult<bool>

Returns true if self and other have at least one interior into each other.

fn disjoint<'b, G: Geom<'b>>(&self, other: &G) -> GResult<bool>

Returns true if self doesn’t:

fn touches<'b, G: Geom<'b>>(&self, other: &G) -> GResult<bool>

Returns true if the only points in common between self and other lie in the union of the boundaries of self and other.

fn overlaps<'b, G: Geom<'b>>(&self, other: &G) -> GResult<bool>

Returns true if self spatially overlaps other.

fn within<'b, G: Geom<'b>>(&self, other: &G) -> GResult<bool>

Returns true if self is completely inside other.

fn equals<'b, G: Geom<'b>>(&self, other: &G) -> GResult<bool>

Checks if the two Geometry objects are equal.

fn equals_exact<'b, G: Geom<'b>>(
    &self,
    other: &G,
    precision: f64
) -> GResult<bool>

Checks if the two Geometry objects are exactly equal.

fn covers<'b, G: Geom<'b>>(&self, other: &G) -> GResult<bool>

Returns true if no point of other is outside of self.

fn covered_by<'b, G: Geom<'b>>(&self, other: &G) -> GResult<bool>

Returns true if no point of self is outside of other.

fn contains<'b, G: Geom<'b>>(&self, other: &G) -> GResult<bool>

Returns true if no points of the other geometry is outside the exterior of self.

fn buffer(&self, width: f64, quadsegs: i32) -> GResult<Geometry<'a>>

Returns a geometry which represents all points whose distance from self is less than or equal to distance.

fn buffer_with_params(
    &self,
    width: f64,
    buffer_params: &BufferParams<'_>
) -> GResult<Geometry<'a>>

Returns a geometry which represents all points whose distance from self is less than or equal to distance.

fn buffer_with_style(
    &self,
    width: f64,
    quadsegs: i32,
    end_cap_style: CapStyle,
    join_style: JoinStyle,
    mitre_limit: f64
) -> GResult<Geometry<'a>>

Returns a geometry which represents all points whose distance from self is less than or equal to distance.

fn is_empty(&self) -> GResult<bool>

Returns true if the given geometry is empty.

fn is_simple(&self) -> GResult<bool>

Returns true if the given geometry has no anomalous geometric points, such as self intersection or self tangency.

fn difference<'b, G: Geom<'b>>(&self, other: &G) -> GResult<Geometry<'a>>

Returns a geometry which represents part of self that doesn’t intersect with other.

fn envelope(&self) -> GResult<Geometry<'a>>

Returns the minimum bouding box of the given geometry.

fn sym_difference<'b, G: Geom<'b>>(&self, other: &G) -> GResult<Geometry<'a>>

Returns a geometry which represents the parts of self and other that don’t intersect.

fn union<'b, G: Geom<'b>>(&self, other: &G) -> GResult<Geometry<'a>>

Aggregates the given geometry with another one.

fn get_centroid(&self) -> GResult<Geometry<'a>>

Returns the geometric center or (equivalently) the center of mass of the given geometry as a point.

fn unary_union(&self) -> GResult<Geometry<'a>>

Documentation from postgis:

fn voronoi<'b, G: Geom<'b>>(
    &self,
    envelope: Option<&G>,
    tolerance: f64,
    only_edges: bool
) -> GResult<Geometry<'a>>

Create a voronoi diagram.

fn intersection<'b, G: Geom<'b>>(&self, other: &G) -> GResult<Geometry<'a>>

Returns a geometry representing the intersection between self and other.

fn convex_hull(&self) -> GResult<Geometry<'a>>

Documentation from postgis:

fn boundary(&self) -> GResult<Geometry<'a>>

Returns the closure of the combinatorial boundary of self.

fn has_z(&self) -> GResult<bool>

Returns true if self has a Z coordinate.

fn is_closed(&self) -> GResult<bool>

Returns true if start and end point are coincident.

fn length(&self) -> GResult<f64>

Returns the length of self. The unit depends of the SRID.

fn distance<'b, G: Geom<'b>>(&self, other: &G) -> GResult<f64>

Returns the distance between self and other. The unit depends of the SRID.

fn distance_indexed<'b, G: Geom<'b>>(&self, other: &G) -> GResult<f64>

Returns the indexed distance between self and other. The unit depends of the SRID.

fn hausdorff_distance<'b, G: Geom<'b>>(&self, other: &G) -> GResult<f64>

Returns the hausdorff distance between self and other. The unit depends of the SRID.

fn hausdorff_distance_densify<'b, G: Geom<'b>>(
    &self,
    other: &G,
    distance_frac: f64
) -> GResult<f64>

Returns the hausdorff distance between self and other. The unit depends of the SRID.

fn frechet_distance<'b, G: Geom<'b>>(&self, other: &G) -> GResult<f64>

Returns the frechet distance between self and other. The unit depends of the SRID.

fn frechet_distance_densify<'b, G: Geom<'b>>(
    &self,
    other: &G,
    distance_frac: f64
) -> GResult<f64>

Returns the frechet distance between self and other. The unit depends of the SRID.

fn get_length(&self) -> GResult<f64>

Returns the length of the given geometry.

fn snap<'b, G: Geom<'b>>(
    &self,
    other: &G,
    tolerance: f64
) -> GResult<Geometry<'a>>

Documentation from postgis:

fn extract_unique_points(&self) -> GResult<Geometry<'a>>

Returns unique points of self.

fn nearest_points<'b, G: Geom<'b>>(&self, other: &G) -> GResult<CoordSeq<'a>>

fn get_x(&self) -> GResult<f64>

Returns the X position. The given Geometry must be a Point, otherwise it’ll fail.

fn get_y(&self) -> GResult<f64>

Returns the Y position. The given Geometry must be a Point, otherwise it’ll fail.

fn get_z(&self) -> GResult<f64>

Returns the Z position. The given Geometry must be a Point, otherwise it’ll fail.

fn get_point_n(&self, n: usize) -> GResult<Geometry<'a>>

Returns the nth point of the given geometry.

fn get_start_point(&self) -> GResult<Geometry<'a>>

Returns the start point of self.

fn get_end_point(&self) -> GResult<Geometry<'a>>

Returns the end point of self.

fn get_num_points(&self) -> GResult<usize>

Returns the number of points of self.

fn get_num_interior_rings(&self) -> GResult<usize>

Returns the number of interior rings.

fn get_num_coordinates(&self) -> GResult<usize>

Returns the number of coordinates inside self.

fn get_num_dimensions(&self) -> GResult<usize>

Returns the number of dimensions used in self.

fn get_coordinate_dimension(&self) -> GResult<Dimensions>

Return in which coordinate dimension the geometry is.

fn make_valid(&self) -> GResult<Geometry<'a>>

This functions attempts to return a valid representation of self.

fn get_num_geometries(&self) -> GResult<usize>

Returns the number of geometries.

fn get_srid(&self) -> GResult<usize>

Get SRID of self.

fn get_precision(&self) -> GResult<f64>

Returns the precision of self.

fn set_precision(
    &self,
    grid_size: f64,
    flags: Precision
) -> GResult<Geometry<'a>>

Returns the precision of self.

fn get_x_max(&self) -> GResult<f64>

Returns the biggest X of the geometry.

fn get_x_min(&self) -> GResult<f64>

Returns the smallest X of the geometry.

fn get_y_max(&self) -> GResult<f64>

Returns the biggest Y of the geometry.

fn get_y_min(&self) -> GResult<f64>

Returns the smallest Y of the geometry.

fn minimum_clearance(&self) -> GResult<f64>

Returns the smallest distance by which a vertex of self could be moved to produce an invalid geometry.

fn minimum_clearance_line(&self) -> GResult<Geometry<'a>>

Returns the two-point LineString spanning of self’s minimum clearance.

fn minimum_rotated_rectangle(&self) -> GResult<Geometry<'a>>

Returns the minimum rotated rectangle inside of self.

fn minimum_width(&self) -> GResult<Geometry<'a>>

Returns the minimum width inside of self.

fn delaunay_triangulation(
    &self,
    tolerance: f64,
    only_edges: bool
) -> GResult<Geometry<'a>>

Returns a delaunay triangulation around the vertices of self.

fn interpolate(&self, d: f64) -> GResult<Geometry<'a>>

fn interpolate_normalized(&self, d: f64) -> GResult<Geometry<'a>>

fn project<'b, G: Geom<'b>>(&self, p: &G) -> GResult<f64>

fn project_normalized<'b, G: Geom<'b>>(&self, p: &G) -> GResult<f64>

fn node(&self) -> GResult<Geometry<'a>>

fn offset_curve(
    &self,
    width: f64,
    quadrant_segments: i32,
    join_style: JoinStyle,
    mitre_limit: f64
) -> GResult<Geometry<'a>>

Return an offset line at a given distance and side from an input line. All points of the returned geometries are not further than the given distance from the input geometry.

fn point_on_surface(&self) -> GResult<Geometry<'a>>

fn polygonize_full(
    &self
) -> GResult<(Geometry<'a>, Option<Geometry<'a>>, Option<Geometry<'a>>, Option<Geometry<'a>>)>

Returns, in the tuple elements order:

fn shared_paths<'b, G: Geom<'b>>(&self, other: &G) -> GResult<Geometry<'a>>

fn to_hex(&self) -> GResult<CVec<u8>>

Converts a Geometry to the HEX format. For more control over the generated output, use the WKBWriter type.

fn to_wkb(&self) -> GResult<CVec<u8>>

Converts a Geometry to the WKB format. For more control over the generated output, use the WKBWriter type.

fn to_prepared_geom<'c>(&'c self) -> GResult<PreparedGeometry<'c>>

Creates a new PreparedGeometry from the current Geometry.

fn clone(&self) -> Geometry<'a>

Also passes the context to the newly created Geometry.

fn get_geometry_n<'c>(&'c self, n: usize) -> GResult<ConstGeometry<'a, 'c>>

Returns the 1-based nth geometry.

fn get_interior_ring_n<'c>(&'c self, n: u32) -> GResult<ConstGeometry<'a, 'c>>

Returns the nth interior ring.

fn get_exterior_ring<'c>(&'c self) -> GResult<ConstGeometry<'a, 'c>>

Returns the exterior ring.

impl<'a, 'b, 'd, G: Geom<'b>> PartialEq<G> for ConstGeometry<'a, 'd>

fn eq(&self, other: &G) -> bool

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

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

This method tests for !=.

impl<'a, 'b, 'c> TryFrom<&'b ConstGeometry<'a, 'c>> for Geometry<f64>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(
    other: &'b ConstGeometry<'a, 'c>
) -> Result<Geometry<f64>, Self::Error>

Performs the conversion.

impl<'a, 'c> TryFrom<ConstGeometry<'a, 'c>> for Geometry<f64>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(other: ConstGeometry<'a, 'c>) -> Result<Geometry<f64>, Self::Error>

Performs the conversion.

impl<'a, 'c> TryFrom<ConstGeometry<'a, 'c>> for Geometry

type Error = Error

The type returned in the event of a conversion error.

fn try_from(other: ConstGeometry<'a, 'c>) -> Result<Geometry, Self::Error>

Performs the conversion.

impl<'a, 'd> Send for ConstGeometry<'a, 'd>

impl<'a, 'd> Sync for ConstGeometry<'a, 'd>