Enum SurfaceError 

pub enum SurfaceError {
    XBelow {
        coordinate: u16,
        bound: u16,
    },
    XAbove {
        coordinate: u16,
        bound: u16,
    },
    YBelow {
        coordinate: u16,
        bound: u16,
    },
    YAbove {
        coordinate: u16,
        bound: u16,
    },
}

A coordinate fell outside the declared domain on a side selecting Boundary::Error.

The four variants distinguish the four sides, so a caller never has to infer which axis rejected the input. Each carries the coordinate that was supplied and the bound that applied to it.

This enum is deliberately not #[non_exhaustive]. The v0.1 contract fixes exactly these four outcomes: shape mismatches are type errors, axis invariants are checked when the surface is defined, and the arithmetic cannot overflow for valid operands. Exhaustive matching without a wildcard arm is therefore both possible and intended.

Variants

XBelow

The X coordinate was below the first X knot.

Fields

coordinate: u16

The rejected X coordinate.

bound: u16

The first X knot: the inclusive lower bound of the X domain.

XAbove

The X coordinate was above the last X knot.

Fields

coordinate: u16

The rejected X coordinate.

bound: u16

The last X knot: the inclusive upper bound of the X domain.

YBelow

The Y coordinate was below the first Y knot.

Fields

coordinate: u16

The rejected Y coordinate.

bound: u16

The first Y knot: the inclusive lower bound of the Y domain.

YAbove

The Y coordinate was above the last Y knot.

Fields

coordinate: u16

The rejected Y coordinate.

bound: u16

The last Y knot: the inclusive upper bound of the Y domain.

Implementations

impl SurfaceError

pub const fn coordinate(&self) -> u16

Returns the coordinate that was rejected, whichever side reported it.

Examples

use ph_surfaces::SurfaceError;

let error = SurfaceError::YAbove {
    coordinate: 900,
    bound: 500,
};

assert_eq!(error.coordinate(), 900);
assert_eq!(error.bound(), 500);

pub const fn bound(&self) -> u16

Returns the bound that applied, whichever side reported it.

For the two below-domain variants this is the first knot of the axis; for the two above-domain variants it is the last knot.

Trait Implementations

impl Clone for SurfaceError

fn clone(&self) -> SurfaceError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for SurfaceError

impl Debug for SurfaceError

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

Formats the value using the given formatter.

impl Display for SurfaceError

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

Formats the value using the given formatter.

impl Eq for SurfaceError

impl Error for SurfaceError

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 Hash for SurfaceError

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for SurfaceError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for SurfaceError