error-forge 0.9.7

A comprehensive Rust error management framework with async support, error recovery patterns, and resilience features for building robust, fault-tolerant applications with rich error handling, formatting, and tracing capabilities.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86

// Example of using the derive(ModError) proc-macro for simple error type creation
// Run this example with: cargo run --example derive_example --features derive
#[allow(unused_imports)]
use error_forge::ForgeError;

// Only available when the "derive" feature is enabled
#[cfg(feature = "derive")]
use error_forge::ModError;

// Define a basic enum error type using derive(ModError)
#[cfg(feature = "derive")]
#[derive(Debug, ModError)]
#[error_prefix = "DATABASE"]
pub enum SimpleDbError {
    // Simple unit variant
    #[error_display("Connection failed")]
    ConnectionFailed,

    // Simple tuple variant with one field
    #[error_display("Query failed: {0}")]
    QueryFailed(String),

    // Unit variant with additional metadata attributes
    #[error_display("Transaction failed")]
    #[error_retryable]
    #[error_http_status(400)]
    TransactionFailed,
}

// A simple struct error type
#[cfg(feature = "derive")]
#[derive(Debug, ModError)]
#[error_prefix("Config")]
pub struct SimpleConfigError;

fn main() {
    // Only compile this section when the "derive" feature is enabled
    #[cfg(feature = "derive")]
    {
        // Create some example errors
        let conn_err = SimpleDbError::ConnectionFailed;
        let query_err = SimpleDbError::QueryFailed("Syntax error in SQL".to_string());
        let tx_err = SimpleDbError::TransactionFailed;
        let config_err = SimpleConfigError;

        // Demonstrate basic ForgeError trait functionality
        println!("=== Derived Error Examples ===");

        println!("\n--- SimpleDbError::ConnectionFailed ---");
        println!("Display: {}", conn_err);
        println!("Raw display format: '{:?}'", format!("{}", conn_err));
        println!("Kind: {}", conn_err.kind());
        println!("Caption: {}", conn_err.caption());
        println!("Raw caption: '{:?}'", conn_err.caption());
        println!("Is retryable: {}", conn_err.is_retryable());
        println!("Status code: {}", conn_err.status_code());

        println!("\n--- SimpleDbError::QueryFailed ---");
        println!("Display: {}", query_err);
        println!("Kind: {}", query_err.kind());
        println!("Caption: {}", query_err.caption());
        println!("Is retryable: {}", query_err.is_retryable());
        println!("Status code: {}", query_err.status_code());

        println!("\n--- SimpleDbError::TransactionFailed ---");
        println!("Display: {}", tx_err);
        println!("Kind: {}", tx_err.kind());
        println!("Caption: {}", tx_err.caption());
        println!("Is retryable: {}", tx_err.is_retryable());
        println!("Status code: {}", tx_err.status_code());

        println!("\n--- SimpleConfigError ---");
        println!("Display: {}", config_err);
        println!("Kind: {}", config_err.kind());
        println!("Caption: {}", config_err.caption());
        println!("Is retryable: {}", config_err.is_retryable());
        println!("Status code: {}", config_err.status_code());
    }

    // When the "derive" feature is not enabled, show this message instead
    #[cfg(not(feature = "derive"))]
    {
        println!("This example requires the 'derive' feature to be enabled.");
        println!("Run it with: cargo run --example derive_example --features derive");
    }
}