Skip to main content

is_valid_with

geometry_overlay::validity

Function is_valid_with 

Source 
pub fn is_valid_with<G>(
    geometry: &G,
    options: ValidityOptions,
) -> Result<(), ValidityFailure>
where
    G: Geometry,
    G::Kind: ValidityStrategyForKind,
    <G::Kind as ValidityStrategyForKind>::S: ValidityStrategy<G>,
Expand description

Validate an areal geometry with explicit validity behavior.

Mirrors the policy-taking overload behind algorithms/detail/is_valid/interface.hpp:155-202. Use ValidityOptions::BOOST_DEFAULT to select Boost’s default handling of consecutive duplicates, or ValidityOptions::STRICT for the behavior of is_valid.

§Errors

Returns the first ValidityFailure not accepted by options.

§Panics

Panics if a custom ring implementation passes validation with a non-empty point iterator but yields no point when iterated again immediately after.