praxis-proxy-filter 0.1.0

Filter pipeline engine and built-in filters 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
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
94
95
96
97
98
99
100

// SPDX-License-Identifier: LGPL-3.0-only
// Copyright (c) 2024 Shane Utt

//! Pre-computed body processing capabilities for filter pipelines.

use super::BodyMode;

// -----------------------------------------------------------------------------
// BodyCapabilities
// -----------------------------------------------------------------------------

/// Pre-computed body processing capabilities for a pipeline.
///
/// ```
/// use praxis_filter::{BodyCapabilities, BodyMode};
///
/// let caps = BodyCapabilities::default();
/// assert!(!caps.needs_request_body);
/// assert!(!caps.needs_response_body);
/// assert_eq!(caps.request_body_mode, BodyMode::Stream);
/// assert_eq!(caps.response_body_mode, BodyMode::Stream);
///
/// let caps = BodyCapabilities {
///     needs_request_body: true,
///     request_body_mode: BodyMode::Buffer { max_bytes: 4096 },
///     ..Default::default()
/// };
/// assert!(caps.needs_request_body);
/// assert!(matches!(
///     caps.request_body_mode,
///     BodyMode::Buffer { max_bytes: 4096 }
/// ));
/// assert!(!caps.needs_response_body, "unset fields stay at default");
/// ```
#[derive(Debug, Clone, Default)]
#[allow(clippy::struct_excessive_bools, reason = "capability flags")]
pub struct BodyCapabilities {
    /// Whether any filter writes to the request body.
    pub any_request_body_writer: bool,

    /// Whether any response condition references headers.
    pub any_response_condition_uses_headers: bool,

    /// Whether any filter writes to the response body.
    pub any_response_body_writer: bool,

    /// Whether any filter needs request body access.
    pub needs_request_body: bool,

    /// Whether any filter needs the original request context during body phases.
    pub needs_request_context: bool,

    /// Whether any filter needs response body access.
    pub needs_response_body: bool,

    /// Resolved request body mode (Buffer if any filter requires it).
    pub request_body_mode: BodyMode,

    /// Resolved response body mode (Buffer if any filter requires it).
    pub response_body_mode: BodyMode,
}

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

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

    #[test]
    fn body_capabilities_default_is_no_op() {
        let caps = BodyCapabilities::default();

        assert!(!caps.needs_request_body, "default caps should not need request body");
        assert!(!caps.needs_response_body, "default caps should not need response body");
        assert!(
            !caps.any_request_body_writer,
            "default caps should have no request body writer"
        );
        assert!(
            !caps.any_response_body_writer,
            "default caps should have no response body writer"
        );
        assert!(
            !caps.needs_request_context,
            "default caps should not need request context"
        );
        assert_eq!(
            caps.request_body_mode,
            BodyMode::Stream,
            "default request mode should be Stream"
        );
        assert_eq!(
            caps.response_body_mode,
            BodyMode::Stream,
            "default response mode should be Stream"
        );
    }
}