Enum PathError 

#[non_exhaustive]
pub enum PathError<S> {
    OutOfDomain {
        param: S,
        domain: RangeInclusive<S>,
    },
    NotDifferentiable {
        param: S,
        reason: &'static str,
    },
    Degenerate {
        reason: &'static str,
    },
    Custom(&'static str),
}

Errors that can occur during path sampling or geometric queries.

The scalar parameter S allows the error to carry the exact parameter value and domain that caused the failure, making diagnostics precise.

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.

OutOfDomain

Arc-length / parameter outside the valid domain.

Fields

param: S

The parameter value that was out of domain.

domain: RangeInclusive<S>

The valid domain [start, end].

NotDifferentiable

The path is not differentiable at param (e.g. a cusp or kink).

Fields

param: S

The parameter where differentiability fails.

reason: &'static str

Human-readable reason.

Degenerate

The path is degenerate (e.g. zero-length segment, collinear control points).

Fields

reason: &'static str

Human-readable reason.

Custom(&'static str)

A custom error with a static description for implementer-specific failures.

Implementations

impl<S: Scalar> PathError<S>

pub fn out_of_domain(param: S, domain: RangeInclusive<S>) -> Self

Create an OutOfDomain error with the offending parameter and valid domain.

pub fn not_differentiable(param: S, reason: &'static str) -> Self

Create a NotDifferentiable error with the parameter and reason.

pub fn degenerate(reason: &'static str) -> Self

Create a Degenerate error with a reason.

Trait Implementations

impl<S: Clone> Clone for PathError<S>

fn clone(&self) -> PathError<S>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S: Debug> Debug for PathError<S>

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

Formats the value using the given formatter.

impl<S: Debug> Display for PathError<S>

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

Formats the value using the given formatter.

impl<S: Debug> Error for PathError<S>

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<S: PartialEq> PartialEq for PathError<S>

fn eq(&self, other: &PathError<S>) -> 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<S> StructuralPartialEq for PathError<S>