Enum ZakatError 

pub enum ZakatError {
    CalculationError(Box<ErrorDetails>),
    InvalidInput(Box<InvalidInputDetails>),
    ConfigurationError(Box<ErrorDetails>),
    Overflow {
        operation: String,
        source_label: Option<String>,
        asset_id: Option<Uuid>,
    },
    MissingConfig {
        field: String,
        source_label: Option<String>,
        asset_id: Option<Uuid>,
    },
    MultipleErrors(Vec<ZakatError>),
    NetworkError(String),
}

Variants

CalculationError(Box<ErrorDetails>)

InvalidInput(Box<InvalidInputDetails>)

ConfigurationError(Box<ErrorDetails>)

Overflow

Fields

operation: String

source_label: Option<String>

asset_id: Option<Uuid>

MissingConfig

Fields

field: String

source_label: Option<String>

asset_id: Option<Uuid>

MultipleErrors(Vec<ZakatError>)

NetworkError(String)

Implementations

impl ZakatError

pub fn error_code(&self) -> ZakatErrorCode

Returns the structured error code enum for programmatic handling.

This is preferred over code() for new code as it provides type safety and enables exhaustive pattern matching.

Example

match err.error_code() {
    ZakatErrorCode::InvalidInput => handle_validation(),
    ZakatErrorCode::BelowNisab => show_exempt_message(),
    _ => handle_generic(),
}

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

Returns a standardized error code string for FFI consumers.

Deprecated: Use error_code() for new code to get the typed enum.

These codes are used by all FFI bindings (Python, Dart, WASM) to programmatically identify error types without parsing error messages.

pub fn with_source(self, source: String) -> ZakatError

pub fn with_asset_id(self, id: Uuid) -> ZakatError

Sets the asset ID for debugging purposes.

pub fn report(&self) -> String

Reports the error as a user-friendly message (basic, non-localized). For localized output, use zakat-i18n crate.

pub fn report_default(&self) -> String

Generates a user-friendly error report.

pub fn context(&self) -> Value

Returns a structured JSON context for the error. Useful for WASM/Frontend consumers.

Trait Implementations

impl Clone for ZakatError

fn clone(&self) -> ZakatError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ZakatError

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ZakatError

fn deserialize<__D>( __deserializer: __D, ) -> Result<ZakatError, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ZakatError

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

Formats the value using the given formatter.

impl Error for ZakatError

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 From<ZakatError> for FfiZakatError

fn from(err: ZakatError) -> FfiZakatError

Converts to this type from the input type.

impl PartialEq for ZakatError

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

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ZakatError