Enum Error 

#[non_exhaustive]
pub enum Error {
    ModelValidation {
        phase: ModelValidationPhase,
        code: String,
        path: Vec<String>,
        message: String,
        source: Option<Box<dyn StdError + Send + Sync + 'static>>,
    },
    Classified {
        category: ErrorCategory,
        phase: Option<ModelValidationPhase>,
        code: String,
        path: Vec<String>,
        diagnostic: Option<Box<ErrorDiagnostic>>,
        message: String,
        source: Option<Box<dyn StdError + Send + Sync + 'static>>,
    },
    SchemaVerification {
        message: String,
        source: Option<Box<dyn StdError + Send + Sync + 'static>>,
    },
    Connection {
        message: String,
        source: Option<Box<dyn StdError + Send + Sync + 'static>>,
    },
    QueryExecution {
        message: String,
        source: Option<Box<dyn StdError + Send + Sync + 'static>>,
    },
    Transaction {
        message: String,
        source: Option<Box<dyn StdError + Send + Sync + 'static>>,
    },
    NotFound {
        message: String,
        source: Option<Box<dyn StdError + Send + Sync + 'static>>,
    },
    Database {
        message: String,
        source: Option<Box<dyn StdError + Send + Sync + 'static>>,
    },
    Other {
        message: String,
        source: Option<Box<dyn StdError + Send + Sync + 'static>>,
    },
}

Primary error type for the TypeBridge client SDK.

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.

ModelValidation

Generated-model evidence did not match the installed schema projection.

Fields

phase: ModelValidationPhase

Validation stage at which the evidence failed.

code: String

Stable language-neutral failure code.

path: Vec<String>

Canonical path to the rejected value or model evidence.

message: String

Human-readable failure summary.

source: Option<Box<dyn StdError + Send + Sync + 'static>>

Optional underlying error that caused the validation failure.

Classified

A structured engine or remote-contract failure mapped into stable client-owned categories, codes, and paths.

Fields

category: ErrorCategory

Stable public error category.

phase: Option<ModelValidationPhase>

Model-validation phase when applicable to this failure.

code: String

Stable language-neutral failure code.

path: Vec<String>

Canonical flattened path to the rejected contract member.

diagnostic: Option<Box<ErrorDiagnostic>>

Typed engine or remote diagnostic metadata, when supplied.

message: String

Human-readable failure summary.

source: Option<Box<dyn StdError + Send + Sync + 'static>>

Optional underlying error that caused the classified failure.

SchemaVerification

Schema verification or installation failed.

Fields

message: String

Human-readable schema verification failure summary.

source: Option<Box<dyn StdError + Send + Sync + 'static>>

Optional underlying schema decoding or installation error.

Connection

Connection to the database failed.

Fields

message: String

Human-readable connection failure summary.

source: Option<Box<dyn StdError + Send + Sync + 'static>>

Optional underlying transport or provider error.

QueryExecution

Database query or operation failed.

Fields

message: String

Human-readable query execution failure summary.

source: Option<Box<dyn StdError + Send + Sync + 'static>>

Optional underlying provider or remote execution error.

Transaction

Database transaction failed.

Fields

message: String

Human-readable transaction failure summary.

source: Option<Box<dyn StdError + Send + Sync + 'static>>

Optional underlying provider transaction error.

NotFound

Requested schema element or database entity was not found.

Fields

message: String

Human-readable description of the missing resource.

source: Option<Box<dyn StdError + Send + Sync + 'static>>

Optional underlying lookup error.

Database

Underlying database error.

Fields

message: String

Human-readable database failure summary.

source: Option<Box<dyn StdError + Send + Sync + 'static>>

Optional underlying database driver error.

Other

Client request or execution error.

Fields

message: String

Human-readable client failure summary.

source: Option<Box<dyn StdError + Send + Sync + 'static>>

Optional underlying error outside the narrower variants.

Implementations

impl Error

pub fn remote( code: impl Into<String>, message: impl Into<String>, source: Option<Box<dyn StdError + Send + Sync + 'static>>, ) -> Self

Construct one application-owned remote transport failure.

Transport implementations should use a stable lowercase snake-case code so callers can handle the failure without parsing its message.

pub const fn category(&self) -> ErrorCategory

Return the stable public failure category.

pub fn sdk_category(&self) -> Option<&'static str>

Return the exact common SDK diagnostic category, when this error directly retains one.

This is an additive, lossless view for generated manager and projected batch diagnostics. Self::category remains the released Rust compatibility classification and may intentionally map SDK invalid_input to ErrorCategory::ModelValidation.

pub fn message(&self) -> &str

Return the error message string.

pub fn code(&self) -> Option<&str>

Return the stable machine-readable failure code, when available.

pub fn path(&self) -> Option<&[String]>

Return the owned structured diagnostic path, when available.

pub fn diagnostic_path(&self) -> Option<&[ErrorPathSegment]>

Return the typed diagnostic path, when the source supplied one.

Self::path remains available as the compatibility-oriented textual projection of the same path.

pub fn details(&self) -> Option<&BTreeMap<String, ErrorDetail>>

Return deterministic typed diagnostic details, when available.

pub const fn model_validation_phase(&self) -> Option<ModelValidationPhase>

Return the model-validation phase, when applicable.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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.