Enum EngineError 

#[non_exhaustive]
pub enum EngineError {
    Stale {
        expected: u64,
        actual: u64,
    },
    Busy {
        reason: String,
    },
    Command {
        error: CommandError,
    },
    Invalid {
        message: String,
    },
    Solve {
        failure: SolveFailure,
    },
    Validation {
        what: String,
        residual: f64,
        tolerance: f64,
    },
    Cancelled,
    NothingToUndo,
    NothingToRedo,
    NotActive {
        what: String,
    },
    Load {
        message: String,
    },
    Plugin {
        message: String,
    },
}

Engine errors. A failed request never changes the document.

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.

Stale

expectedRevision does not match.

Fields

expected: u64

Expected.

actual: u64

Actual.

Busy

Another interaction (drag or pending solve) is in progress.

Fields

reason: String

Reason.

Command

A command was rejected.

Fields

error: CommandError

Error.

Invalid

The resulting document would violate an invariant.

Fields

message: String

Explanation.

Solve

Hard rules could not be satisfied.

Fields

failure: SolveFailure

Details.

Validation

The independent check found a violated hard rule after solving.

Fields

what: String

Rule.

residual: f64

Residual.

tolerance: f64

Tolerance.

Cancelled

The operation was cancelled.

NothingToUndo

Nothing to undo.

NothingToRedo

Nothing to redo.

NotActive

No interaction of the requested kind is active.

Fields

what: String

What.

Load

Loading a document failed.

Fields

message: String

Explanation.

Plugin

Plugin registration failed.

Fields

message: String

Explanation.

Implementations

impl EngineError

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

Stable machine-readable code.

pub fn solve_status(&self) -> Option<Status>

Solve status if this is a solve failure.

Trait Implementations

impl Clone for EngineError

fn clone(&self) -> EngineError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EngineError

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EngineError

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for EngineError

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

Formats the value using the given formatter.

impl Error for EngineError

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<CommandError> for EngineError

fn from(error: CommandError) -> Self

Converts to this type from the input type.

impl PartialEq for EngineError

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for EngineError

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for EngineError