Enum MetricsError 

pub enum MetricsError {
    BasicError(String),
    ShapeError(String),
    RangeError(String),
    TrendError(String),
    RiskError(String),
    Curve(CurveError),
    Surface(SurfaceError),
}

Error types specifically related to financial and statistical metrics calculations.

This enum represents various error conditions that can occur during metrics processing, analysis, and validation within the library’s metrics module. Each variant provides context about the specific type of error encountered.

Variants

• BasicError - General metrics calculation errors
• ShapeError - Errors related to data shape mismatches or incompatible dimensions
• RangeError - Errors when data falls outside of expected/valid ranges
• TrendError - Errors in trend analysis, regression, or pattern detection
• RiskError - Errors in risk metrics calculations (like VaR, Sharpe ratio, etc.)
• Curve - Errors related to curve-fitting or curve-based calculations
• Surface - Errors in surface modeling or multi-dimensional metrics

Examples

use optionstratlib::error::MetricsError;

// Creating different error types
let basic_err = MetricsError::BasicError("Calculation failed".to_string());
let range_err = MetricsError::RangeError("Value outside expected bounds".to_string());

Variants

BasicError(String)

General errors in metrics calculations.

ShapeError(String)

Errors related to data shape mismatches or dimensional incompatibility. This typically occurs when input data has an unexpected structure.

RangeError(String)

Errors when data falls outside expected or valid ranges. This can indicate outliers or invalid input values.

TrendError(String)

Errors in trend analysis, regression, or pattern detection algorithms.

RiskError(String)

Errors specifically related to financial risk metrics calculations, such as Value at Risk (VaR), Conditional VaR, or Sharpe ratio.

Curve(CurveError)

Errors encountered during curve-fitting or curve-based calculations, such as yield curves or volatility curves.

Surface(SurfaceError)

Errors in surface modeling or multi-dimensional metrics, such as volatility surfaces or correlation matrices.

Trait Implementations

impl Debug for MetricsError

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

Formats the value using the given formatter.

impl Display for MetricsError

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

Formats the value using the given formatter.

impl Error for MetricsError

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 From<CurveError> for MetricsError

fn from(source: CurveError) -> Self

Converts to this type from the input type.

impl From<MetricsError> for CurveError

Converts a PositionError into a CurvesError by mapping it to an OperationError with the InvalidParameters variant.

This implementation ensures a smooth transition between error types when a PositionError is encountered within a context that operates on the curves module. The InvalidParameters variant is used to provide detailed information about the failed operation and the reason for its failure.

Details:

• The operation field is hardcoded as "Position" to indicate the context of the error (i.e., relating to position management).
• The reason field is derived from the to_string representation of the PositionError, ensuring a human-readable explanation.

Example Integration:

1. If a PositionError is encountered during curve calculations, this implementation converts it into a CurvesError for consistent error handling within the curves module.
2. The generated CurvesError provides detailed diagnostic information about the reason for the failure, enabling effective debugging.

Implementation Notes:

• This conversion leverages the OperationErrorKind::InvalidParameters variant to communicate that invalid parameters (or settings) were the root cause of failure.
• Use this implementation to handle interoperability between error types in modular design contexts.

Example Use Case:

This conversion is frequently used in scenarios where:

• A position-related error (e.g., from validation or limits) occurs during a curve operation.
• Such errors need to be mapped into the CurvesError domain to maintain consistent error handling across the library.

Debugging:

The resulting CurvesError will include contextual details, making it straightforward to trace and debug the underlying issue.

fn from(err: MetricsError) -> Self

Converts to this type from the input type.

impl From<MetricsError> for Error

fn from(source: MetricsError) -> Self

Converts to this type from the input type.

impl From<SurfaceError> for MetricsError

fn from(source: SurfaceError) -> Self

Converts to this type from the input type.