Enum ErrorCode 

#[non_exhaustive]
pub enum ErrorCode {
    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,
}

One variant per E_* code of SPEC 10.2, and E_EVAL_UNAVAILABLE (RS-28). Non-exhaustive: codes added by later revisions of the specification are additions.

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.

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 or signature not lowercase hex of the right length.

CanonLicence

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

CanonSet

inputs not strictly ascending.

CanonLimit

A limit from 4.5 exceeded.

Slice

A slice marker where a single cell is required.

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 is a cell of an undeclared function.

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 resolver could not evaluate the function (step 7.6): no runtime for its language, a budget exceeded, or inputs the evaluator cannot obtain. Not a failure: the receipt stays signature-valid (see crate::VerifyResult). This crate’s code, proposed for spec-0.2.2 (DEFECTS.md RS-28); not in spec-0.2.1’s 10.2, so envelopes cannot carry it.

Implementations

impl ErrorCode

pub const ALL: &'static [ErrorCode]

Every code, in the order of SPEC 10.2, then E_EVAL_UNAVAILABLE.

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

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

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

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

Trait Implementations

impl Clone for ErrorCode

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ErrorCode

impl Debug for ErrorCode

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

Formats the value using the given formatter.

impl Display for ErrorCode

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

Formats the value using the given formatter.

impl Eq for ErrorCode

impl Hash for ErrorCode

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for ErrorCode

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

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.

impl PartialEq for ErrorCode

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for ErrorCode

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

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl StructuralPartialEq for ErrorCode