Struct TrellisError 

pub struct TrellisError<O, E> {
    pub cause: ErrorCause<E>,
    pub result: Option<O>,
}

An error wrapper for trellis calculations

The error wraps the underlying error type ErrorCause, which contains information about the reason the calculation failed. In addition it can optionally return the an output from the calculation. This is useful in situations where a failure occured due to running out of iterations, or termination from the parent thread, but the state of the calculation at that point may still contain meaningful information. Maybe the calculation ran out of iterations because it was unable to reach the required tolerance, but is still at convergence?

Fields

cause: ErrorCause<E>

The underlying error cause.

result: Option<O>

An optional result which can be extracted by the caller

Trait Implementations

impl<O: Debug, E: Debug> Debug for TrellisError<O, E>

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

Formats the value using the given formatter.

impl<O, E: Debug> Display for TrellisError<O, E>

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

Formats the value using the given formatter.

impl<O, E> Error for TrellisError<O, E>

where ErrorCause<E>: Error + 'static, Self: Debug + Display,

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<O, E> From<E> for TrellisError<O, E>

fn from(cause: E) -> Self

Converts to this type from the input type.