Enum Error 

#[non_exhaustive]
pub enum Error {
    OutOfRange {
        parameter: String,
        id: Option<String>,
        min: Option<f64>,
        max: Option<f64>,
        exclusive_min: Option<f64>,
        exclusive_max: Option<f64>,
        got: f64,
        range: String,
    },
    EmptyInput {
        parameter: String,
    },
    InvalidOption {
        parameter: String,
        message: String,
    },
    UnknownOption {
        parameter: String,
        got: String,
        expected: Vec<String>,
    },
    MalformedInput {
        parameter: Option<String>,
        message: String,
    },
    NotFinite {
        parameter: String,
        id: Option<String>,
        index: Option<usize>,
        got: f64,
    },
    Cancelled,
    InvalidGeometry {
        id: Option<String>,
        message: String,
    },
    DuplicateId {
        id: String,
        first: usize,
        second: usize,
    },
    InvalidBoundary {
        parameter: Option<String>,
        message: String,
    },
    Internal(String),
}

Why the engine refused a request or could not finish it. Each variant carries what a caller needs to point at the input to change – the setting, the geometry id, the positions – as fields, not only in the message; Error::code is the stable name of the reason.

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.

OutOfRange

A setting outside the values it accepts, and range says it in words. min / max are the closed bounds (the value may equal them), exclusive_min / exclusive_max the open ones (it must lie strictly beyond them). A side has at most one of the two; None on both means that side is unbounded. id names the geometry the setting belongs to, when it belongs to one (a quantity).

Fields

parameter: String

id: Option<String>

min: Option<f64>

max: Option<f64>

exclusive_min: Option<f64>

exclusive_max: Option<f64>

got: f64

range: String

EmptyInput

A list the request must not leave empty – parameter names it (geometries): there is nothing to solve.

Fields

parameter: String

InvalidOption

A setting that cannot be used as given (a strategy this build or this dimension does not offer, …).

Fields

parameter: String

message: String

UnknownOption

An option name the engine does not know: got is the name given and expected the names it accepts.

Fields

parameter: String

got: String

expected: Vec<String>

MalformedInput

A request of the wrong shape: not JSON, a missing or unknown key, a value of the wrong type. parameter names the part when it is known.

Fields

parameter: Option<String>

message: String

NotFinite

A number that is not finite (NaN or an infinity), where a request holds numbers – a transport whose values can carry one (a Python float) refuses it before the request is read. parameter is the path of the value, or of the list it is in, and index its position in that list; id names the geometry it belongs to.

Fields

parameter: String

id: Option<String>

index: Option<usize>

got: f64

Cancelled

The caller cancelled the run.

InvalidGeometry

A geometry the engine cannot work with, named by its id when the check that refused it knows the geometry.

Fields

id: Option<String>

message: String

DuplicateId

Two geometries share an id, at positions first and second of the request (counting from 0).

Fields

id: String

first: usize

second: usize

InvalidBoundary

A boundary the engine cannot place into; parameter names the field when one field is at fault.

Fields

parameter: Option<String>

message: String

Internal(String)

A failure inside the engine, not caused by the request.

Implementations

impl Error

pub fn code(&self) -> &'static str

The stable name of the reason: parameter_out_of_range, empty_input, invalid_option, unknown_option, malformed_input, value_not_finite, invalid_geometry, duplicate_id, invalid_boundary, cancelled or internal.

pub fn parameter(&self) -> Option<&str>

The setting or request part the refusal names, when it names one.

pub fn located(self, section: &str, fields: &[&str]) -> Self

This refusal with its parameter named by its path under section when it is one of fields – spacing, a field of the request’s config, becomes config.spacing – and unchanged otherwise.

The Rust API names a setting by its field, as the configuration type the caller built has it; a request names it by where it sits in the request. The wire layer, which knows the request, places it.

pub fn empty_input(parameter: &str) -> Self

A list the request must not leave empty.

pub fn invalid_option(parameter: &str, message: String) -> Self

A setting that cannot be used as given.

pub fn invalid_geometry(id: Option<&str>, message: String) -> Self

A geometry refused by a check that may or may not know which one.

pub fn malformed(parameter: Option<&str>, message: String) -> Self

A request of the wrong shape, naming the part when it is known.

pub fn invalid_boundary(parameter: Option<&str>, message: String) -> Self

A boundary refused, naming the field when one is at fault.

Trait Implementations

impl Clone for Error

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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 Error

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Error