esox_objectpool 1.1.2

High-performance, thread-safe object pool with async support, circuit breaker, eviction, health monitoring and Prometheus metrics
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
87
88
89
90
91
92
93

//! Error types for the object pool
//!
//! # Examples
//!
//! ```
//! use esox_objectpool::{ObjectPool, PoolConfiguration, PoolError};
//!
//! let pool = ObjectPool::new(vec![1], PoolConfiguration::default());
//! let _obj = pool.get_object().unwrap();
//!
//! // Pool is now empty
//! let result = pool.get_object();
//! assert!(matches!(result, Err(PoolError::PoolEmpty)));
//! ```

use thiserror::Error;

#[derive(Error, Debug, Clone)]
pub enum PoolError {
    #[error("Pool is empty - no objects available")]
    PoolEmpty,
    
    #[error("Pool is at maximum capacity")]
    PoolFull,
    
    #[error("Operation timed out after {0:?}")]
    Timeout(std::time::Duration),
    
    #[error("No object matching the query was found")]
    NoMatchFound,
    
    #[error("Object validation failed")]
    ValidationFailed,
    
    #[error("Circuit breaker is open - too many failures")]
    CircuitBreakerOpen,
    
    #[error("Maximum active objects limit reached")]
    MaxActiveObjectsReached,
    
    #[error("Operation was cancelled")]
    Cancelled,
}

pub type PoolResult<T> = Result<T, PoolError>;

#[cfg(test)]
mod tests {
    use super::*;
    use std::time::Duration;

    #[test]
    fn error_display_messages() {
        assert_eq!(PoolError::PoolEmpty.to_string(), "Pool is empty - no objects available");
        assert_eq!(PoolError::PoolFull.to_string(), "Pool is at maximum capacity");
        assert_eq!(PoolError::NoMatchFound.to_string(), "No object matching the query was found");
        assert_eq!(PoolError::ValidationFailed.to_string(), "Object validation failed");
        assert_eq!(PoolError::CircuitBreakerOpen.to_string(), "Circuit breaker is open - too many failures");
        assert_eq!(PoolError::MaxActiveObjectsReached.to_string(), "Maximum active objects limit reached");
        assert_eq!(PoolError::Cancelled.to_string(), "Operation was cancelled");
    }

    #[test]
    fn timeout_display_includes_duration() {
        let msg = PoolError::Timeout(Duration::from_secs(30)).to_string();
        assert!(msg.contains("30s") || msg.contains("30"), "expected duration in: {msg}");
    }

    #[test]
    fn errors_are_clone() {
        let e = PoolError::PoolEmpty;
        let cloned = e.clone();
        assert_eq!(e.to_string(), cloned.to_string());
    }

    #[test]
    fn errors_are_debug() {
        let cases: &[PoolError] = &[
            PoolError::PoolEmpty,
            PoolError::PoolFull,
            PoolError::Timeout(Duration::from_millis(100)),
            PoolError::NoMatchFound,
            PoolError::ValidationFailed,
            PoolError::CircuitBreakerOpen,
            PoolError::MaxActiveObjectsReached,
            PoolError::Cancelled,
        ];
        for e in cases {
            assert!(!format!("{e:?}").is_empty());
        }
    }
}