Skip to main content

ErrorCode

Enum ErrorCode 

Source
#[non_exhaustive]
pub enum ErrorCode {
Show 49 variants ParseJson, ParseDuplicateKey, ParseUri, Schema, CanonName, CanonArgName, CanonArgDuplicate, CanonArgOrder, CanonPercent, CanonType, CanonNumber, CanonUnit, CanonDate, CanonInstant, CanonString, CanonBlob, CanonHex, CanonLicence, CanonSet, CanonLimit, Slice, PublisherMismatch, ValidMismatch, TimeOrder, ArgUnknown, ArgMissing, KeyUnavailable, KeyDoc, KeyUnknown, KeyNotValid, Signature, FnUnavailable, FnHashMismatch, ArgType, ReturnType, InputUnavailable, InputInvalid, InputUndeclared, ValueMismatch, BlobMismatch, Envelope, EvalUnavailable, SliceMember, InputSuperseded, JobUnknown, MeshDoc, SliceAtCell, NameUnbound, ForeignUnavailable,
}
Expand description

One variant per E_* code of SPEC 10.2 (spec-0.4.3). Non-exhaustive: codes added by later revisions of the specification are additions.

The variants are declared in the order of 10.2, except the codes added within 0.3.x, which follow in the order they were added so that ErrorCode::ALL and the derived ordering only grow: EvalUnavailable (0.3.0; 10.2 lists it between E_VALUE_MISMATCH and E_BLOB_MISMATCH), then SliceMember and InputSuperseded (0.3.4, spec-0.4.0; 10.2 lists them after E_INPUT_UNDECLARED and after E_EVAL_UNAVAILABLE), then JobUnknown and MeshDoc (0.3.5, spec-0.4.1; last in 10.2 too, after E_ENVELOPE), then SliceAtCell and NameUnbound (0.3.6, spec-0.4.2, after E_MESH_DOC), then ForeignUnavailable (0.3.7, spec-0.4.3, last in 10.2 too). The formula codes of SPEC 15.11 are not verification codes and have no variant; the envelope’s fault is a crate::Fault.

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

ParseJson

Not strict JSON (6.1).

§

ParseDuplicateKey

A member name repeated in one object.

§

ParseUri

Not a cell URI by the outer grammar (5.1).

§

Schema

Missing or extra member, wrong JSON type, wrong proto, null; content for a non-blob.

§

CanonName

Invalid DNS name, namespace, function name, code language or key reference.

§

CanonArgName

Invalid or reserved argument name.

§

CanonArgDuplicate

An argument or asof repeated in a URI.

§

CanonArgOrder

URI arguments out of order, or asof not last.

§

CanonPercent

Non-canonical percent-encoding or non-UTF-8 bytes.

§

CanonType

Unknown type name, value of the wrong JSON type, or a bad valid-time declaration.

§

CanonNumber

Number not in canonical decimal form.

§

CanonUnit

A unit rule of 7.1 or units.md broken.

§

CanonDate

Date not YYYY-MM-DD or not a calendar day.

§

CanonInstant

Instant not YYYY-MM-DDTHH:MM:SS.ffffffZ or not a real time.

§

CanonString

Control, unassigned or surrogate code point, not NFC, or empty summary.

§

CanonBlob

Blob not <sha256>:<length>:<media type>.

§

CanonHex

Hash, key id, signature or slice entry not lowercase hex of the right length.

§

CanonLicence

Licence neither an SPDX identifier nor an https:// URL.

§

CanonSet

inputs, an extent or manifest members not strictly ascending; order not every argument exactly once.

§

CanonLimit

A limit from 4.5 exceeded.

§

Slice

A slice marker where a single cell is required; a slice object without an open or ranged argument.

§

PublisherMismatch

publisher differs from cell.ns.

§

ValidMismatch

valid does not echo exactly the valid-time arguments.

§

TimeOrder

A time-order rule broken.

§

ArgUnknown

An argument the function does not declare.

§

ArgMissing

A declared argument not bound.

§

KeyUnavailable

The key document could not be retrieved.

§

KeyDoc

The key document is malformed or breaks a rule of 9.2.

§

KeyUnknown

The key document has no key with that id.

§

KeyNotValid

issued is outside the key’s validity window.

§

Signature

The Ed25519 signature does not verify.

§

FnUnavailable

No descriptor found for fn_hash.

§

FnHashMismatch

The descriptor does not hash to fn_hash.

§

ArgType

An argument’s type differs from its declaration.

§

ReturnType

type differs from the declared return type.

§

InputUnavailable

An input receipt cannot be found, or has another hash.

§

InputInvalid

An input receipt is not signature-valid.

§

InputUndeclared

An input receipt, or a slice, is of a function not in the descriptor’s inputs.

§

ValueMismatch

Recomputation gives a different type or value.

§

BlobMismatch

Blob content has another length or hash than the blob states.

§

Envelope

A response envelope breaks a rule of 5.5.

§

EvalUnavailable

The verifier could not evaluate the function (10.1 step 7.6): no runtime for its language, a budget exceeded, or inputs the evaluator cannot obtain. Not a failure: it is reported with success at level signed (see crate::VerifyResult). A mesh may carry it in an error envelope (5.5). In 10.2 since spec-0.3.0 (RS-28).

§

SliceMember

A member receipt does not belong to its slice, or two members of a membership slice are one cell (10.1 step 7.5, spec-0.4.0).

§

InputSuperseded

Recomputation read a later version of an input cell, or other members of an input slice (10.1 step 7.6, spec-0.4.0): the receipt is historical, not wrong. Not a failure: it is reported with success at level signed, at path $.inputs (see crate::VerifyResult).

§

JobUnknown

In a bad_request envelope at a job URL: the job is unknown or expired (5.5, spec-0.4.1). A mesh’s code, not a client’s or a verification result.

§

MeshDoc

The mesh document cannot be retrieved, is malformed, breaks a rule of 9.6, or disagrees with the key document on host or proto (crate::resolve_mesh, spec-0.4.1). Never a verification result.

§

SliceAtCell

In a bad_request envelope: the /cell request has a slice marker; slices are read at the slice endpoint (5.6, spec-0.4.2). A mesh’s code.

§

NameUnbound

In a not_covered envelope’s error: the name (or alias) is not bound as of the requested asof; it may be bound later (5.5, 5.8, spec-0.4.2). A mesh’s code.

§

ForeignUnavailable

In an error envelope, with HTTP 502 and a detail (crate::ForeignDetail): the cell belongs to another mesh, which could not be reached (offline, network, DNS, TLS, timeout, a refused connection; 5.5, 9.6, spec-0.4.3). A mesh’s or resolver’s code, never a verification result.

Implementations§

Source§

impl ErrorCode

Source

pub const ALL: &'static [ErrorCode]

Every code, in the order of SPEC 10.2 except the codes added within 0.3.x, which come last (see ErrorCode).

Source

pub const fn as_str(self) -> &'static str

The code as written in the specification, e.g. "E_SIGNATURE".

Source

pub fn from_code(text: &str) -> Option<ErrorCode>

Looks a code up by its text; None for anything not in ErrorCode::ALL.

Trait Implementations§

Source§

impl Clone for ErrorCode

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 Copy for ErrorCode

Source§

impl Debug for ErrorCode

Source§

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

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

impl Display for ErrorCode

Source§

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

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

impl Eq for ErrorCode

Source§

impl Hash for ErrorCode

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Ord for ErrorCode

Source§

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 (const: unstable) · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 (const: unstable) · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 (const: unstable) · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

fn clamp_to<R>(self, range: R) -> Self
where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)
Restrict a value to a certain range. Read more
Source§

impl PartialEq for ErrorCode

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl PartialOrd for ErrorCode

Source§

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl StructuralPartialEq for ErrorCode

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