praxis-proxy-core 0.6.0

Configuration, error types, and server factory for Praxis
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

// SPDX-License-Identifier: Apache-2.0
// Copyright (c) 2024 Praxis Contributors

//! Shared error types for the Praxis workspace.
//!
//! [`ProxyError`] is the primary error type, re-exported from `praxis_core`.

use thiserror::Error;

// -----------------------------------------------------------------------------
// Errors
// -----------------------------------------------------------------------------

/// Errors that can occur during proxy operation.
///
/// Runtime routing failures (no route matched, no healthy upstream) are
/// not `ProxyError` variants: the router and load balancer short-circuit
/// with filter rejections, and upstream connect failures surface through
/// the protocol layer's error classification.
///
/// ```
/// use praxis_core::ProxyError;
///
/// let e = ProxyError::Config("bad yaml".into());
/// assert_eq!(e.to_string(), "config: bad yaml");
/// ```
#[derive(Debug, Error)]
pub enum ProxyError {
    /// Configuration loading or validation error.
    ///
    /// Raised during startup or hot-reload when YAML parsing or
    /// validation fails. Not retriable; fix the configuration.
    /// The server continues running with the previous config on
    /// hot-reload failures.
    #[error("config: {0}")]
    Config(String),
}

// -----------------------------------------------------------------------------
// Tests
// -----------------------------------------------------------------------------

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

    #[test]
    fn error_display() {
        let err = ProxyError::Config("bad yaml".into());
        assert_eq!(err.to_string(), "config: bad yaml", "Config error display mismatch");
    }
}