Skip to main content

EngineError

Enum EngineError 

Source
#[non_exhaustive]
pub enum EngineError { DeadlineExceeded { partial_lint: LintResult, }, InvalidThreshold(InvalidThreshold), }
Expand description

Runtime errors from Engine::lint_with_options / Engine::fix_with_options (spec 005).

Distinct from EngineConstructionError by design — construction errors are build-time configuration defects the integrator fixes before shipping; EngineError reports runtime conditions (a per-call deadline expired, a per-call threshold override is out of range) the caller can react to. Keeping the two enums separate means matching on one does not force callers to pattern against build-time variants they could never encounter at request time.

#[non_exhaustive] so future runtime conditions (memory budget exceeded, per-rule deadline expired, cancellation token tripped) can land without a semver-breaking change.

Spec §R5 (asymmetric response shape): the lint path does not return EngineError::DeadlineExceeded on its own — partial lint results are surfaced through LintResult.truncated instead, so the caller can render whatever diagnostics were produced before the abort. Only fix_with_options raises DeadlineExceeded, because a partial FixResult would commit half a fix to the audit stream (Constitution V Principle V).

Variants (Non-exhaustive)§

This enum is marked as 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.
§

DeadlineExceeded

fix_with_options aborted before applying every fix because the call’s deadline expired. partial_lint is the LintResult that the lint pass produced before the abort — callers can render its diagnostics to the user even though no fixes were committed. partial_lint.truncated indicates whether the lint pass itself was also truncated (deadline expired during scanning) versus the fix-application loop (lint pass completed, fixes did not).

Carries the lint result by value (not boxed) because the happy path returns Ok(FixResult) and the size penalty on the error variant is paid only on the cold path.

Fields

§partial_lint: LintResult
§

InvalidThreshold(InvalidThreshold)

fix_with_options rejected the per-call confidence threshold override. Wraps the existing standalone InvalidThreshold struct so Engine::fix_with_threshold can keep its Result<FixResult, InvalidThreshold> public signature unchanged while internally routing through fix_with_options.

Trait Implementations§

Source§

impl Debug for EngineError

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for EngineError

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Error for EngineError

Source§

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

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

1.0.0 · Source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

Source§

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. Read more
Source§

impl From<InvalidThreshold> for EngineError

Source§

fn from(value: InvalidThreshold) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> HostError for T
where T: Any + Error + Send + Sync + 'static,