Trait AsyncForgeError

Source

pub trait AsyncForgeError:
    StdError
    + Send
    + Sync
    + 'static {
    // Required methods
    fn kind(&self) -> &'static str;
    fn caption(&self) -> &'static str;
    fn async_handle<'life0, 'async_trait>(
        &'life0 self,
    ) -> Pin<Box<dyn Future<Output = Result<(), Box<dyn StdError + Send + Sync>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;

    // Provided methods
    fn is_retryable(&self) -> bool { ... }
    fn is_fatal(&self) -> bool { ... }
    fn status_code(&self) -> u16 { ... }
    fn exit_code(&self) -> i32 { ... }
    fn user_message(&self) -> String { ... }
    fn dev_message(&self) -> String { ... }
    fn backtrace(&self) -> Option<&Backtrace> { ... }
    fn register(&self) { ... }
}

Expand description

An async-compatible version of the ForgeError trait.

This trait extends the standard error capabilities with async support, allowing for async error handling in futures and async functions.

§Example

use error_forge::async_error::AsyncForgeError;
use async_trait::async_trait;

#[derive(Debug)]
struct MyAsyncError { message: String }

impl std::fmt::Display for MyAsyncError {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "{}", self.message)
    }
}

impl std::error::Error for MyAsyncError {}

#[async_trait]
impl AsyncForgeError for MyAsyncError {
    fn kind(&self) -> &'static str {
        "AsyncExample"
    }
     
    fn caption(&self) -> &'static str {
        "Async Example Error"
    }
     
    async fn async_handle(&self) -> Result<(), Box<dyn StdError + Send + Sync>> {
        // Perform async error handling here
        println!("Handling async error: {}", self);
        Ok(())
    }
}