Skip to main content

EvalError

Enum EvalError 

Source
#[non_exhaustive]
pub enum EvalError {
Show 13 variants NoRuntime { lang: String, }, UndeclaredInput { fn_name: String, }, Cycle { path: Vec<String>, }, DepthExceeded { limit: usize, }, BudgetExceeded { fuel: u64, }, NameUnresolved { fn_name: String, asof: String, }, Store(StoreError), Runtime(String), Suspended, InputNotCovered { cell_id: String, }, InvalidInput(Error), Fault(Fault), BlobUnavailable { sha256: String, reason: String, },
}
Expand description

What evaluating a function can fail with: returned by Inputs::read and Budget::charge, and by a Runtime.

A runtime propagates every error it gets from Inputs::read or Budget::charge unchanged (with ?). The engine does not depend on it: it records each such error when it happens, and what the runtime returns after it is ignored.

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.
§

NoRuntime

No runtime is configured for the function’s code.lang.

Fields

§lang: String

The language.

§

UndeclaredInput

The function read a function its descriptor does not declare in inputs.

Fields

§fn_name: String

The fully qualified name read.

§

Cycle

The cell reappeared on the evaluation stack: it depends on itself. The path holds the canonical calls in read order, from the cell that reappeared to its second occurrence.

Fields

§path: Vec<String>

The canonical calls of the cycle (SPEC 5.8), the first and last equal.

§

DepthExceeded

The evaluation stack reached the engine’s depth limit.

Fields

§limit: usize

The limit.

§

BudgetExceeded

The request’s fuel (runtime steps plus input reads) ran out.

Fields

§fuel: u64

The fuel the request had.

§

NameUnresolved

A function name has no binding as of the evaluation’s asof.

Fields

§fn_name: String

The fully qualified name.

§asof: String

The asof.

§

Store(StoreError)

The store failed.

§

Runtime(String)

The runtime failed: its own message.

§

Suspended

The input read is not available yet: the engine evaluates it, then runs the reading function again from the start (see Inputs). Added to the brief’s list: it is how evaluation suspends without native recursion.

§

InputNotCovered

The input has no value as of the evaluation’s asof (a stored cell with no version answering then, or a computed cell one of whose inputs has none). The reading cell has no value either (Answer::NotCovered), even if the runtime catches it: a receipt lists the inputs read, and cannot list an absence, so a value computed from one could be neither checked against its inputs nor recomputed. Added to the brief’s list.

Fields

§cell_id: String

The input cell’s id.

§

InvalidInput(Error)

The arguments given to Inputs::read do not make a cell of the input function (a slice, an unknown or missing argument, a type that differs from the signature). Added to the brief’s list: it is the runtime’s mistake, not the engine’s or the store’s.

§

Fault(Fault)

A formula evaluation fault (SPEC 15.11, 15.12): the cell has no value, deterministically (E_FORMULA_DIV_ZERO, E_FORMULA_DOMAIN, E_FORMULA_RANGE, E_FORMULA_EMPTY, E_FORMULA_ABSENT, E_FORMULA_FUTURE). Returned by a runtime, it makes the answer Answer::NotCovered with the fault, and nothing is stored for the cell. Returned by a read (an input that faulted, a computed slice with a member without a value, a transaction time after the asof), the runtime may catch it where its language allows. Since 0.3.0.

§

BlobUnavailable

A blob’s content could not be obtained (Inputs::read_blob): the store has none for its SHA-256, or what it has is not the blob’s (another length or hash). The evaluator’s failure, not a fault of the cell (SPEC 15.12, E_FORMULA_BLOB_UNAVAILABLE): the request fails with EngineError::BlobUnavailable whatever the runtime returns after it. Since 0.3.2.

Fields

§sha256: String

The blob’s SHA-256.

§reason: String

Why: no content, or content of another length or hash.

Trait Implementations§

Source§

impl Clone for EvalError

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for EvalError

Source§

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

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

impl Display for EvalError

Source§

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

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

impl Error for EvalError

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

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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 = !

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

fn try_from(value: U) -> Result<T, !>

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