Enum FunctionErrors 

pub enum FunctionErrors<InputError: Error, OutputError: Error> {
    Input {
        source: InputError,
    },
    Output {
        source: OutputError,
    },
}

A generic error type for fallible numerical function computations.

This enum is used as a standard wrapper for function-specific errors, distinguishing between failures that occur during input validation and those that occur during output validation (or due to the computation itself resulting in an invalid value according to the defined policy).

Type Parameters

• InputError: The type of the error that occurs if input validation fails. This is typically a function-specific enum detailing various input-related problems (e.g., ExpInputErrors,, LogarithmRealInputErrors, etc.).
• OutputError: The type of the error that occurs if output validation fails. This is usually an error type related to the properties of the scalar value itself, often from the core::errors module (e.g., ErrorsValidationRawReal or ErrorsValidationRawComplex), indicating that the computed result is not valid (e.g., NaN, Infinity).

Variants

Input

Error due to invalid input values.

This variant is returned when initial validation of the function’s arguments fails according to the defined validation policy (e.g., StrictFinitePolicy) or due to domain-specific constraints (e.g., negative input to a real logarithm).

Fields

source: InputError

The source error that occurred during input validation. This provides specific details about why the input was considered invalid.

Output

Error due to the computed output failing validation.

This variant is returned if the result of the computation, even from valid inputs, fails validation according to the defined policy. This typically means the result was non-finite (NaN or Infinity) or otherwise did not meet the criteria for a valid output.

Fields

source: OutputError

The source error that occurred during output validation. This provides specific details about why the computed output was considered invalid.

Trait Implementations

impl<InputError: Debug + Error, OutputError: Debug + Error> Debug for FunctionErrors<InputError, OutputError>

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

Formats the value using the given formatter.

impl<InputError: Error, OutputError: Error> Display for FunctionErrors<InputError, OutputError>

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

Formats the value using the given formatter.

impl<InputError, OutputError> Error for FunctionErrors<InputError, OutputError>

where InputError: Error + 'static + Error, OutputError: Error + 'static + Error, Self: Debug + Display,

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

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

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

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

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

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

impl<InputError: Error, OutputError: Error> From<InputError> for FunctionErrors<InputError, OutputError>

fn from(source: InputError) -> Self

Converts to this type from the input type.