Enum PolygonError 

#[non_exhaustive]
pub enum PolygonError {
    NoOuterRing,
    TooFewVertices {
        ring: RingId,
        count: usize,
    },
    RepeatedVertex {
        ring: RingId,
        index: usize,
        point: Point,
    },
    DegenerateRing {
        ring: RingId,
    },
    Spike {
        ring: RingId,
        vertex: VertexId,
    },
    SelfIntersection {
        a: EdgeId,
        b: EdgeId,
    },
    HoleOutsideOuter {
        ring: RingId,
    },
    TooManyVertices {
        count: usize,
        max: usize,
    },
    CoordinateOutOfRange {
        ring: RingId,
        point: Point,
    },
}

Why a Polygon could not be built.

Every variant names the ring (and where meaningful the vertex or edge) responsible, so the caller can point at the offending input rather than guessing.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

NoOuterRing

A polygon needs an outer ring; none was supplied.

TooFewVertices

A ring had fewer than three distinct vertices.

Fields

ring: RingId

The offending ring.

count: usize

How many vertices it had.

RepeatedVertex

A ring repeated a vertex back to back, giving a zero-length edge.

Fields

ring: RingId

The offending ring.

index: usize

Index of the repeat within the ring.

point: Point

The duplicated point.

DegenerateRing

A ring encloses no area (every vertex is collinear).

Fields

ring: RingId

The offending ring.

Spike

A ring doubles back on itself through 180°, forming a zero-width spike.

The wavefront vertex at such a corner would have to move infinitely fast, so the skeleton is undefined there. Nudge the spike tip sideways by one unit, or drop it.

Fields

ring: RingId

The offending ring.

vertex: VertexId

The spike tip.

SelfIntersection

Two edges of the polygon cross. Simple polygons only.

Fields

a: EdgeId

One of the crossing edges.

b: EdgeId

The other crossing edge.

HoleOutsideOuter

A hole is not contained in the outer ring.

Fields

ring: RingId

The offending hole.

TooManyVertices

The polygon has more vertices than EdgeId can number.

Fields

count: usize

How many vertices were supplied.

max: usize

The most that can be numbered.

CoordinateOutOfRange

A vertex lies outside the crate’s coordinate range.

Coordinates are capped at Point::MIN_COORD..=Point::MAX_COORD, one bit narrower than i16. That bit is what makes every predicate exact in i32 and lets the whole algorithm run without f64 — see Point and crate::predicates. Scale the input down to fit.

Fields

ring: RingId

The ring it is in.

point: Point

The offending point.

Trait Implementations

impl Clone for PolygonError

fn clone(&self) -> PolygonError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PolygonError

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

Formats the value using the given formatter.

impl Display for PolygonError

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

Formats the value using the given formatter.

impl Eq for PolygonError

impl Error for PolygonError

Available on crate feature std only.

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl PartialEq for PolygonError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for PolygonError