Enum CoreError 

pub enum CoreError {
    InvalidPassword,
    InvalidPasswordFormat(String),
    Locked,
    AlgorithmMismatch {
        expected: String,
        actual: String,
    },
    UnsupportedAlgorithm(String),
    MalformedDocument(String),
    MalformedKey(String),
    MalformedEnvelope(String),
    SignatureInvalid(String),
    EncryptionFailed(String),
    DecryptionFailed(String),
    SchemaInvalid(String),
    AgreementFailed(String),
}

Protocol-layer error.

One variant per failure mode. Variant names are stable wire identifiers (they appear as the code field of the serialized error); do not rename without bumping the JACS WASM contract.

Variants

InvalidPassword

The supplied password does not unlock the encrypted private key.

InvalidPasswordFormat(String)

The supplied password is structurally invalid (e.g. empty).

Locked

The agent has been locked via clear_secrets; sign operations are rejected until re-unlocked. Verification still works.

AlgorithmMismatch

The caller asked for one algorithm but the loaded material is a different one.

Fields

expected: String

The algorithm the caller requested.

actual: String

The algorithm actually present on the loaded material.

UnsupportedAlgorithm(String)

The algorithm identifier or envelope magic is unknown / reserved.

MalformedDocument(String)

The JACS document is structurally invalid (missing field, wrong type, malformed canonical bytes, …).

MalformedKey(String)

A key blob is malformed (wrong length, bad PKCS#8 structure, …).

MalformedEnvelope(String)

The encrypted-key envelope is structurally invalid (short, bad JSON, missing field, …). Distinct from InvalidPassword.

SignatureInvalid(String)

The cryptographic signature did not verify against the supplied public key + payload.

EncryptionFailed(String)

AEAD encryption failed.

DecryptionFailed(String)

AEAD decryption failed (tag mismatch, KDF error, …). Distinct from InvalidPassword, which is the specific case where the password itself was wrong.

SchemaInvalid(String)

JSON schema validation failed.

AgreementFailed(String)

Multi-party agreement quorum / payload check failed.

Implementations

impl CoreError

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

Stable wire identifier for this error (the code field of the serialized payload). Match this in client code instead of comparing to the localized message.

Trait Implementations

impl Clone for CoreError

fn clone(&self) -> CoreError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CoreError

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

Formats the value using the given formatter.

impl Display for CoreError

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

Formats the value using the given formatter.

impl Eq for CoreError

impl Error for CoreError

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 PartialEq for CoreError

fn eq(&self, other: &CoreError) -> 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 CoreError

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Stable JSON shape: { code, message, details? }. details is only present when the variant has structured fields beyond a single human-readable string. This shape is the wire contract — see module docs.

impl StructuralPartialEq for CoreError