Enum EffectError 

pub enum EffectError {
    NotFound {
        resource: String,
    },
    InvalidInput {
        message: String,
    },
    NetworkError {
        message: String,
    },
    PermissionDenied {
        message: String,
    },
    Timeout {
        message: String,
    },
    Custom {
        code: String,
        message: String,
        data: Option<Value>,
    },
}

Effect-specific error with common variants and Custom fallback.

This error type is returned by effect handlers when operations fail. It provides structured information that can be serialized across the WASM boundary and handled programmatically by the guest.

Common Patterns

• NotFound: Resource doesn’t exist (file, issue, entity)
• InvalidInput: Request parameters failed validation
• NetworkError: External service unreachable or returned error
• Custom: Domain-specific errors with extensible structure

Example

use crate::effects::EffectError;

fn find_entity(id: &str) -> Result<(), EffectError> {
    // Simulate a lookup that fails
    if id == "not_found" {
        Err(EffectError::not_found(format!("entity/{}", id)))
    } else {
        Ok(())
    }
}

Variants

NotFound

Resource not found.

Fields

resource: String

Description of the missing resource (e.g., “issue/123”, “file/README.md”).

InvalidInput

Invalid input parameters.

Fields

message: String

Human-readable description of the validation failure.

NetworkError

Network or external service error.

Fields

message: String

Description of the network failure.

PermissionDenied

Permission denied.

Fields

message: String

Description of the permission failure.

Timeout

Operation timed out.

Fields

message: String

Description of what timed out.

Custom

Custom domain-specific error.

Use this for errors that don’t fit the common patterns above. External consumers can define their own error codes and structures.

Fields

code: String

Application-specific error code (e.g., “egregore.signal_failed”).

message: String

Human-readable error message.

data: Option<Value>

Optional structured data for debugging/handling.

Implementations

impl EffectError

pub fn not_found(resource: impl Into<String>) -> Self

Create a not found error.

pub fn invalid_input(message: impl Into<String>) -> Self

Create an invalid input error.

pub fn network_error(message: impl Into<String>) -> Self

Create a network error.

pub fn permission_denied(message: impl Into<String>) -> Self

Create a permission denied error.

pub fn timeout(message: impl Into<String>) -> Self

Create a timeout error.

pub fn custom(code: impl Into<String>, message: impl Into<String>) -> Self

Create a custom error with code and message.

pub fn custom_with_data( code: impl Into<String>, message: impl Into<String>, data: Value, ) -> Self

Create a custom error with additional data.

Trait Implementations

impl Clone for EffectError

fn clone(&self) -> EffectError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EffectError

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EffectError

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for EffectError

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

Formats the value using the given formatter.

impl Error for EffectError

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 EffectError

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for EffectError