Skip to content
On this page

geos.GEOSisValid ⇒ number

Tests whether a geometry is valid according to the OGC rules for geometry validity.

Kind: Exported member
Returns: number - 1 if the geometry is valid, 0 if it is invalid, or -1 if an error occurred.
See: https://docs.rs/geos-sys/1.0.10/geos_sys/fn.GEOSisValid.html

ParamTypeDescription
geomnumberThe geometry to test.

geos.GEOSisValidDetail ⇒ number

Returns a valid_detail row, containing a boolean stating if a geometry is valid, a varchar stating a reason why it is invalid and a geometry pointing out where it is invalid.

Kind: Exported member
Returns: number - 1 if the geometry is valid, 0 if it is invalid, or -1 on error
See: GEOSisValidDetail

ParamTypeDescription
gnumberA pointer to a GEOSGeometry object
flagsnumberA bitfield for setting options. See ST_IsValidDetail for details.
reasonstringA pointer to store the null-terminated string describing the validity of the geometry
locationnumberA pointer to store the GEOSGeometry object indicating the location of invalidity

geos.GEOSisValidDetail_r ⇒ number

Returns a valid_detail row, containing a boolean stating if a geometry is valid, a varchar stating a reason why it is invalid and a geometry pointing out where it is invalid. Thread-safe version.

Kind: Exported member
Returns: number - 1 if the geometry is valid, 0 if it is invalid, or -1 on error
See: GEOSisValidDetail_r

ParamTypeDescription
handlenumberA GEOS context handle
gnumberA pointer to a GEOSGeometry object
flagsnumberA bitfield for setting options. See ST_IsValidDetail for details.
reasonstringA pointer to store the null-terminated string describing the validity of the geometry
locationnumberA pointer to store the GEOSGeometry object indicating the location of invalidity

geos.GEOSisValidReason ⇒ string

Returns text stating if a geometry is valid, or if invalid a reason why.

Kind: Exported member
Returns: string - A null-terminated string describing the validity of the geometry
See: GEOSisValidReason

ParamTypeDescription
gnumberA pointer to a GEOSGeometry object

geos.GEOSisValidReason_r ⇒ string

Returns text stating if a geometry is valid, or if invalid a reason why. Thread-safe version.

Kind: Exported member
Returns: string - A null-terminated string describing the validity of the geometry
See: GEOSisValidReason_r

ParamTypeDescription
handlenumberA GEOS context handle
gnumberA pointer to a GEOSGeometry object

geos.GEOSisValid_r ⇒ number

Tests whether a geometry is valid according to the OGC rules for geometry validity.

Kind: Exported member
Returns: number - 1 if the geometry is valid, 0 if it is invalid, or -1 if an error occurred.
See: https://docs.rs/geos-sys/1.0.10/geos_sys/fn.GEOSisValid_r.html

ParamTypeDescription
handlenumberA pointer to the GEOS context handle.
geomnumberThe geometry to test.