praxis-proxy-filter 0.4.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

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

//! Body access declarations for filter pipeline stages.

// -----------------------------------------------------------------------------
// BodyAccess
// -----------------------------------------------------------------------------

/// Declares whether a filter needs access to request or response bodies.
///
/// ```
/// use praxis_filter::BodyAccess;
///
/// let access = BodyAccess::default();
/// assert_eq!(access, BodyAccess::None);
/// ```
#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
pub enum BodyAccess {
    /// No body access needed.
    #[default]
    None,

    /// Read-only access.
    ReadOnly,

    /// Read-write access.
    ReadWrite,
}

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

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

    #[test]
    fn body_access_default_is_none() {
        assert_eq!(
            BodyAccess::default(),
            BodyAccess::None,
            "default BodyAccess should be None"
        );
    }

    #[test]
    fn body_access_variants_are_distinct() {
        assert_ne!(
            BodyAccess::None,
            BodyAccess::ReadOnly,
            "None and ReadOnly should differ"
        );
        assert_ne!(
            BodyAccess::ReadOnly,
            BodyAccess::ReadWrite,
            "ReadOnly and ReadWrite should differ"
        );
        assert_ne!(
            BodyAccess::None,
            BodyAccess::ReadWrite,
            "None and ReadWrite should differ"
        );
    }
}